Folders and files
| Name | Name | Last commit date | ||
|---|---|---|---|---|
OpenAPI 3.1 specification for the Rclone RC API.
npm install rclone-openapi// ESM
import schema from 'rclone-openapi';
// CommonJS
const schema = require('rclone-openapi');Or import directly:
import schema from 'rclone-openapi/openapi.json';The YAML version is also available at openapi.yaml.
This package includes auto-generated TypeScript types for the Rclone RC API:
import type { paths, operations, components } from 'rclone-openapi';
// Example: Type for the /config/listremotes response
type ListRemotesResponse = paths['/config/listremotes']['post']['responses']['200']['content']['application/json'];
// Example: Type for operations
type CopyFileParams = operations['operationsCopyfile']['parameters']['query'];
// Example: Async operations return 202 with a job ID
type AsyncJob = components['responses']['AsyncJobResponse']['content']['application/json'];Works great with API clients like openapi-fetch:
import createClient from 'openapi-fetch';
import type { paths } from 'rclone-openapi';
const client = createClient<paths>({ baseUrl: 'http://localhost:5572' });
// Synchronous call
const { data, error } = await client.POST('/config/listremotes');
// Async call — returns 202 with { jobid }
const { data: job } = await client.POST('/sync/copy', {
body: { srcFs: 'drive:src', dstFs: 'drive:dst', _async: true },
headers: { Prefer: 'respond-async' },
});| File | Description |
|---|---|
| openapi.json | OpenAPI 3.1 specification (JSON) |
| openapi.yaml | OpenAPI 3.1 specification (YAML) |
| types.d.ts | TypeScript type definitions |
Generate the JSON schema and TypeScript types from the YAML source:
npm run gen # Generate both JSON and types
npm run gen:json # Generate JSON only
npm run gen:types # Generate TypeScript types only- Rclone SDK — Ready-to-use client built on this spec (supports Rust and Javascript/Typescript)
- Rclone RC API Documentation
- Rclone — Cloud storage sync tool
MIT
Made with ☁️ for the rclone community