{"id":51167682,"url":"https://github.com/rclone/rclone-openapi","last_synced_at":"2026-06-26T21:01:40.790Z","repository":{"id":335662749,"uuid":"1111419987","full_name":"rclone/rclone-openapi","owner":"rclone","description":"OpenAPI 3.1 specification for the Rclone RC API","archived":false,"fork":false,"pushed_at":"2026-06-05T16:43:00.000Z","size":466,"stargazers_count":41,"open_issues_count":0,"forks_count":3,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-21T12:29:42.507Z","etag":null,"topics":["backblaze-b2","cloudinary","cyberduck","dropbox","filezilla","ftp","fuse","google-cloud-storage","google-drive","icloud","internxt","koofr","openapi","proton","rclone","rclone-browser","rclone-gui","rsync","s3","sftp"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/rclone.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null},"funding":{"github":["rclone"],"custom":["https://rclone.org/sponsor/","https://rclone.com/"]}},"created_at":"2025-12-06T22:36:36.000Z","updated_at":"2026-06-16T15:13:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/rclone/rclone-openapi","commit_stats":null,"previous_names":["rclone-ui/rclone-openapi","rclone/rclone-openapi"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/rclone/rclone-openapi","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-openapi","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-openapi/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-openapi/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-openapi/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rclone","download_url":"https://codeload.github.com/rclone/rclone-openapi/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rclone%2Frclone-openapi/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34832916,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-26T02:00:06.560Z","response_time":106,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["backblaze-b2","cloudinary","cyberduck","dropbox","filezilla","ftp","fuse","google-cloud-storage","google-drive","icloud","internxt","koofr","openapi","proton","rclone","rclone-browser","rclone-gui","rsync","s3","sftp"],"created_at":"2026-06-26T21:01:39.833Z","updated_at":"2026-06-26T21:01:40.785Z","avatar_url":"https://github.com/rclone.png","language":"JavaScript","funding_links":["https://github.com/sponsors/rclone","https://rclone.org/sponsor/","https://rclone.com/"],"categories":[],"sub_categories":[],"readme":"# Rclone OpenAPI\n\n[![Discord](https://img.shields.io/badge/Discord-%235865F2.svg?\u0026logo=discord\u0026logoColor=white)](https://discord.gg/rclone)\n[![npm version](https://img.shields.io/npm/v/rclone-openapi?color=cb0000\u0026logo=npm)](https://www.npmjs.com/package/rclone-openapi)\n[![npm downloads](https://img.shields.io/npm/dm/rclone-openapi?color=cb0000\u0026logo=npm)](https://www.npmjs.com/package/rclone-openapi)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n\nOpenAPI 3.1 specification for the [**Rclone RC API**](https://rclone.org/rc/).\n\n## Installation\n\n```bash\nnpm install rclone-openapi\n```\n\n## Usage\n\n### Import the OpenAPI Schema\n\n```javascript\n// ESM\nimport schema from 'rclone-openapi';\n\n// CommonJS\nconst schema = require('rclone-openapi');\n```\n\nOr import directly:\n\n```javascript\nimport schema from 'rclone-openapi/openapi.json';\n```\n\nThe YAML version is also available at **`openapi.yaml`**.\n\n### TypeScript Types\n\nThis package includes auto-generated TypeScript types for the Rclone RC API:\n\n```typescript\nimport type { paths, operations, components } from 'rclone-openapi';\n\n// Example: Type for the /config/listremotes response\ntype ListRemotesResponse = paths['/config/listremotes']['post']['responses']['200']['content']['application/json'];\n\n// Example: Type for operations\ntype CopyFileParams = operations['operationsCopyfile']['parameters']['query'];\n\n// Example: Async operations return 202 with a job ID\ntype AsyncJob = components['responses']['AsyncJobResponse']['content']['application/json'];\n```\n\nWorks great with API clients like [**openapi-fetch**](https://openapi-ts.dev/openapi-fetch/):\n\n```typescript\nimport createClient from 'openapi-fetch';\nimport type { paths } from 'rclone-openapi';\n\nconst client = createClient\u003cpaths\u003e({ baseUrl: 'http://localhost:5572' });\n\n// Synchronous call\nconst { data, error } = await client.POST('/config/listremotes');\n\n// Async call — returns 202 with { jobid }\nconst { data: job } = await client.POST('/sync/copy', {\n  body: { srcFs: 'drive:src', dstFs: 'drive:dst', _async: true },\n  headers: { Prefer: 'respond-async' },\n});\n```\n\n## Files\n\n| File | Description |\n|------|-------------|\n| **`openapi.json`** | OpenAPI 3.1 specification (JSON) |\n| **`openapi.yaml`** | OpenAPI 3.1 specification (YAML) |\n| **`types.d.ts`** | TypeScript type definitions |\n\n## Development\n\nGenerate the JSON schema and TypeScript types from the YAML source:\n\n```bash\nnpm run gen        # Generate both JSON and types\nnpm run gen:json   # Generate JSON only\nnpm run gen:types  # Generate TypeScript types only\n```\n\n## Related\n\n- [**Rclone SDK**](https://github.com/rclone-ui/rclone-sdk) — Ready-to-use client built on this spec (supports Rust and Javascript/Typescript)\n- [**Rclone** RC API Documentation](https://rclone.org/rc/)\n- [**Rclone**](https://rclone.org/) — Cloud storage sync tool\n\n## License\n\nMIT\n\n\u003cbr /\u003e\n\u003cbr /\u003e\n\n\u003cdiv align=\"center\"\u003e\n\u003csub\u003eMade with ☁️ for the \u003ca href=\"https://discord.gg/rclone\"\u003erclone community\u003c/a\u003e\u003c/sub\u003e\n\u003c/div\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frclone%2Frclone-openapi","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frclone%2Frclone-openapi","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frclone%2Frclone-openapi/lists"}