rclone-openapi 1.0.12 → 1.0.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/openapi.yaml +4974 -0
  2. package/package.json +3 -2
package/openapi.yaml ADDED
@@ -0,0 +1,4974 @@
1
+ # openapi: "3.0.1"
2
+ openapi: 3.1.0
3
+ info:
4
+ title: Rclone RC API
5
+ version: 0.1.2
6
+ description: "Full OpenAPI specification for the Rclone RC API."
7
+ contact:
8
+ name: GitHub Repository
9
+ url: https://github.com/rclone-ui/rclone-openapi
10
+ license:
11
+ name: MIT
12
+ url: https://opensource.org/licenses/MIT
13
+ servers:
14
+ - url: http://localhost:5572
15
+ description: Local rclone RC endpoint
16
+ paths:
17
+ /rc/noop:
18
+ post:
19
+ summary: "Echo request parameters"
20
+ description: "Returns all supplied parameters unchanged so you can verify RC connectivity."
21
+ tags: []
22
+ operationId: rcNoop
23
+ parameters:
24
+ - $ref: "#/components/parameters/Rc_NoopPostAdditionalParam"
25
+ - $ref: "#/components/parameters/GlobalAsyncParam"
26
+ responses:
27
+ "200":
28
+ $ref: "#/components/responses/RcNoopResponse"
29
+ "4XX":
30
+ $ref: "#/components/responses/RcError"
31
+ "5XX":
32
+ $ref: "#/components/responses/RcError"
33
+ /operations/cleanup:
34
+ post:
35
+ summary: "Remove trashed files"
36
+ description: "Permanently removes trashed objects from the specified remote path."
37
+ tags: []
38
+ operationId: operationsCleanup
39
+ parameters:
40
+ - $ref: "#/components/parameters/Operations_CleanupPostFsParam"
41
+ - $ref: "#/components/parameters/GlobalGroupParam"
42
+ - $ref: "#/components/parameters/GlobalAsyncParam"
43
+ responses:
44
+ "200":
45
+ $ref: "#/components/responses/EmptyObjectResponse"
46
+ "4XX":
47
+ $ref: "#/components/responses/RcError"
48
+ "5XX":
49
+ $ref: "#/components/responses/RcError"
50
+ /operations/copyfile:
51
+ post:
52
+ summary: "Copy a single file"
53
+ description: "Copies one object from a source remote and path to a destination remote and path."
54
+ tags: []
55
+ operationId: operationsCopyfile
56
+ parameters:
57
+ - $ref: "#/components/parameters/Operations_CopyfilePostSrcFsParam"
58
+ - $ref: "#/components/parameters/Operations_CopyfilePostSrcRemoteParam"
59
+ - $ref: "#/components/parameters/Operations_CopyfilePostDstFsParam"
60
+ - $ref: "#/components/parameters/Operations_CopyfilePostDstRemoteParam"
61
+ - $ref: "#/components/parameters/GlobalGroupParam"
62
+ - $ref: "#/components/parameters/GlobalAsyncParam"
63
+ responses:
64
+ "200":
65
+ $ref: "#/components/responses/EmptyObjectResponse"
66
+ "4XX":
67
+ $ref: "#/components/responses/RcError"
68
+ "5XX":
69
+ $ref: "#/components/responses/RcError"
70
+ /operations/copyurl:
71
+ post:
72
+ summary: "Copy from URL"
73
+ description: "Downloads a public URL and stores it at the requested remote path."
74
+ tags: []
75
+ operationId: operationsCopyurl
76
+ parameters:
77
+ - $ref: "#/components/parameters/Operations_CopyurlPostFsParam"
78
+ - $ref: "#/components/parameters/Operations_CopyurlPostRemoteParam"
79
+ - $ref: "#/components/parameters/Operations_CopyurlPostUrlParam"
80
+ - $ref: "#/components/parameters/Operations_CopyurlPostAutoFilenameParam"
81
+ - $ref: "#/components/parameters/GlobalGroupParam"
82
+ - $ref: "#/components/parameters/GlobalAsyncParam"
83
+ responses:
84
+ "200":
85
+ $ref: "#/components/responses/EmptyObjectResponse"
86
+ "4XX":
87
+ $ref: "#/components/responses/RcError"
88
+ "5XX":
89
+ $ref: "#/components/responses/RcError"
90
+ /operations/delete:
91
+ post:
92
+ summary: "Delete objects in path"
93
+ description: "Deletes matching files and directories for the provided remote, honouring filters and config overrides."
94
+ tags: []
95
+ operationId: operationsDelete
96
+ parameters:
97
+ - $ref: "#/components/parameters/Operations_DeletePostFsParam"
98
+ - $ref: "#/components/parameters/GlobalConfigParam"
99
+ - $ref: "#/components/parameters/GlobalFilterParam"
100
+ - $ref: "#/components/parameters/GlobalGroupParam"
101
+ - $ref: "#/components/parameters/GlobalAsyncParam"
102
+ responses:
103
+ "200":
104
+ $ref: "#/components/responses/EmptyObjectResponse"
105
+ "4XX":
106
+ $ref: "#/components/responses/RcError"
107
+ "5XX":
108
+ $ref: "#/components/responses/RcError"
109
+ /operations/deletefile:
110
+ post:
111
+ summary: "Delete single file"
112
+ description: "Removes a specific object from the remote."
113
+ tags: []
114
+ operationId: operationsDeletefile
115
+ parameters:
116
+ - $ref: "#/components/parameters/Operations_DeletefilePostFsParam"
117
+ - $ref: "#/components/parameters/Operations_DeletefilePostRemoteParam"
118
+ - $ref: "#/components/parameters/GlobalGroupParam"
119
+ - $ref: "#/components/parameters/GlobalAsyncParam"
120
+ responses:
121
+ "200":
122
+ $ref: "#/components/responses/EmptyObjectResponse"
123
+ "4XX":
124
+ $ref: "#/components/responses/RcError"
125
+ "5XX":
126
+ $ref: "#/components/responses/RcError"
127
+ /operations/fsinfo:
128
+ post:
129
+ summary: "Describe remote capabilities"
130
+ description: "Returns backend features, hash support, metadata descriptions, and other info for the remote."
131
+ tags: []
132
+ operationId: operationsFsinfo
133
+ parameters:
134
+ - $ref: "#/components/parameters/Operations_FsinfoPostFsParam"
135
+ - $ref: "#/components/parameters/GlobalGroupParam"
136
+ - $ref: "#/components/parameters/GlobalAsyncParam"
137
+ responses:
138
+ "200":
139
+ $ref: "#/components/responses/OperationsFsinfoResponse"
140
+ "4XX":
141
+ $ref: "#/components/responses/RcError"
142
+ "5XX":
143
+ $ref: "#/components/responses/RcError"
144
+ /operations/hashsum:
145
+ post:
146
+ summary: "Generate hash sums"
147
+ description: "Produces a hash sum listing for files under the given path using the requested hash algorithm."
148
+ tags: []
149
+ operationId: operationsHashsum
150
+ parameters:
151
+ - $ref: "#/components/parameters/Operations_HashsumPostFsParam"
152
+ - $ref: "#/components/parameters/Operations_HashsumPostHashTypeParam"
153
+ - $ref: "#/components/parameters/Operations_HashsumPostDownloadParam"
154
+ - $ref: "#/components/parameters/Operations_HashsumPostBase64Param"
155
+ - $ref: "#/components/parameters/GlobalGroupParam"
156
+ - $ref: "#/components/parameters/GlobalAsyncParam"
157
+ responses:
158
+ "200":
159
+ $ref: "#/components/responses/OperationsHashsumResponse"
160
+ "4XX":
161
+ $ref: "#/components/responses/RcError"
162
+ "5XX":
163
+ $ref: "#/components/responses/RcError"
164
+ /operations/movefile:
165
+ post:
166
+ summary: "Move a single file"
167
+ description: "Moves one object from a source remote and path to a destination remote and path."
168
+ tags: []
169
+ operationId: operationsMovefile
170
+ parameters:
171
+ - $ref: "#/components/parameters/Operations_MovefilePostSrcFsParam"
172
+ - $ref: "#/components/parameters/Operations_MovefilePostSrcRemoteParam"
173
+ - $ref: "#/components/parameters/Operations_MovefilePostDstFsParam"
174
+ - $ref: "#/components/parameters/Operations_MovefilePostDstRemoteParam"
175
+ - $ref: "#/components/parameters/GlobalGroupParam"
176
+ - $ref: "#/components/parameters/GlobalAsyncParam"
177
+ responses:
178
+ "200":
179
+ $ref: "#/components/responses/EmptyObjectResponse"
180
+ "4XX":
181
+ $ref: "#/components/responses/RcError"
182
+ "5XX":
183
+ $ref: "#/components/responses/RcError"
184
+ /operations/publiclink:
185
+ post:
186
+ summary: "Create or remove public link"
187
+ description: "Creates a share URL for an object or removes an existing link when `unlink=true`."
188
+ tags: []
189
+ operationId: operationsPubliclink
190
+ parameters:
191
+ - $ref: "#/components/parameters/Operations_PubliclinkPostFsParam"
192
+ - $ref: "#/components/parameters/Operations_PubliclinkPostRemoteParam"
193
+ - $ref: "#/components/parameters/Operations_PubliclinkPostUnlinkParam"
194
+ - $ref: "#/components/parameters/Operations_PubliclinkPostExpireParam"
195
+ - $ref: "#/components/parameters/GlobalGroupParam"
196
+ - $ref: "#/components/parameters/GlobalAsyncParam"
197
+ responses:
198
+ "200":
199
+ $ref: "#/components/responses/OperationsPubliclinkResponse"
200
+ "4XX":
201
+ $ref: "#/components/responses/RcError"
202
+ "5XX":
203
+ $ref: "#/components/responses/RcError"
204
+ /operations/rmdirs:
205
+ post:
206
+ summary: "Remove empty directories"
207
+ description: "Deletes empty subdirectories beneath the specified path, optionally leaving the root."
208
+ tags: []
209
+ operationId: operationsRmdirs
210
+ parameters:
211
+ - $ref: "#/components/parameters/Operations_RmdirsPostFsParam"
212
+ - $ref: "#/components/parameters/Operations_RmdirsPostRemoteParam"
213
+ - $ref: "#/components/parameters/Operations_RmdirsPostLeaveRootParam"
214
+ - $ref: "#/components/parameters/GlobalGroupParam"
215
+ - $ref: "#/components/parameters/GlobalAsyncParam"
216
+ responses:
217
+ "200":
218
+ $ref: "#/components/responses/EmptyObjectResponse"
219
+ "4XX":
220
+ $ref: "#/components/responses/RcError"
221
+ "5XX":
222
+ $ref: "#/components/responses/RcError"
223
+ /operations/settier:
224
+ post:
225
+ summary: "Change storage tier"
226
+ description: "Updates the storage class or tier for every object in the specified remote path."
227
+ tags: []
228
+ operationId: operationsSettier
229
+ parameters:
230
+ - $ref: "#/components/parameters/Operations_SettierPostFsParam"
231
+ - $ref: "#/components/parameters/GlobalGroupParam"
232
+ - $ref: "#/components/parameters/GlobalAsyncParam"
233
+ responses:
234
+ "200":
235
+ $ref: "#/components/responses/EmptyObjectResponse"
236
+ "4XX":
237
+ $ref: "#/components/responses/RcError"
238
+ "5XX":
239
+ $ref: "#/components/responses/RcError"
240
+ /operations/settierfile:
241
+ post:
242
+ summary: "Change file storage tier"
243
+ description: "Updates the storage class or tier for a single object."
244
+ tags: []
245
+ operationId: operationsSettierfile
246
+ parameters:
247
+ - $ref: "#/components/parameters/Operations_SettierfilePostFsParam"
248
+ - $ref: "#/components/parameters/Operations_SettierfilePostRemoteParam"
249
+ - $ref: "#/components/parameters/GlobalGroupParam"
250
+ - $ref: "#/components/parameters/GlobalAsyncParam"
251
+ responses:
252
+ "200":
253
+ $ref: "#/components/responses/EmptyObjectResponse"
254
+ "4XX":
255
+ $ref: "#/components/responses/RcError"
256
+ "5XX":
257
+ $ref: "#/components/responses/RcError"
258
+ /operations/size:
259
+ post:
260
+ summary: "Count remote size"
261
+ description: "Reports total size, file count, and number of objects without size metadata."
262
+ tags: []
263
+ operationId: operationsSize
264
+ parameters:
265
+ - $ref: "#/components/parameters/Operations_SizePostFsParam"
266
+ - $ref: "#/components/parameters/GlobalGroupParam"
267
+ - $ref: "#/components/parameters/GlobalAsyncParam"
268
+ responses:
269
+ "200":
270
+ $ref: "#/components/responses/OperationsSizeResponse"
271
+ "4XX":
272
+ $ref: "#/components/responses/RcError"
273
+ "5XX":
274
+ $ref: "#/components/responses/RcError"
275
+ /core/bwlimit:
276
+ post:
277
+ summary: "Get or update bandwidth limits"
278
+ description: "Reads the current bandwidth limit or applies a new schedule string, just like `rclone rc core/bwlimit`."
279
+ tags: []
280
+ operationId: coreBwlimit
281
+ parameters:
282
+ - $ref: "#/components/parameters/Core_BwlimitPostRateParam"
283
+ - $ref: "#/components/parameters/GlobalGroupParam"
284
+ - $ref: "#/components/parameters/GlobalAsyncParam"
285
+ responses:
286
+ "200":
287
+ $ref: "#/components/responses/CoreBwlimitResponse"
288
+ "4XX":
289
+ $ref: "#/components/responses/RcError"
290
+ "5XX":
291
+ $ref: "#/components/responses/RcError"
292
+ /core/command:
293
+ post:
294
+ summary: "Run an rclone command"
295
+ description: "Executes a standard rclone CLI command remotely and streams or returns its output."
296
+ tags: []
297
+ operationId: coreCommand
298
+ parameters:
299
+ - $ref: "#/components/parameters/Core_CommandPostCommandParam"
300
+ - $ref: "#/components/parameters/Core_CommandPostArgParam"
301
+ - $ref: "#/components/parameters/Core_CommandPostOptParam"
302
+ - $ref: "#/components/parameters/Core_CommandPostReturnTypeParam"
303
+ - $ref: "#/components/parameters/GlobalGroupParam"
304
+ - $ref: "#/components/parameters/GlobalAsyncParam"
305
+ responses:
306
+ "200":
307
+ $ref: "#/components/responses/CoreCommandResponse"
308
+ "4XX":
309
+ $ref: "#/components/responses/RcError"
310
+ "5XX":
311
+ $ref: "#/components/responses/RcError"
312
+ /core/du:
313
+ post:
314
+ summary: "Report disk usage"
315
+ description: "Returns disk usage statistics for the supplied local directory (defaults to the cache dir)."
316
+ tags: []
317
+ operationId: coreDu
318
+ parameters:
319
+ - $ref: "#/components/parameters/Core_DuPostDirParam"
320
+ - $ref: "#/components/parameters/GlobalGroupParam"
321
+ - $ref: "#/components/parameters/GlobalAsyncParam"
322
+ responses:
323
+ "200":
324
+ $ref: "#/components/responses/CoreDuResponse"
325
+ "4XX":
326
+ $ref: "#/components/responses/RcError"
327
+ "5XX":
328
+ $ref: "#/components/responses/RcError"
329
+ /core/gc:
330
+ post:
331
+ summary: "Force garbage collection"
332
+ description: "Triggers Go's garbage collector to release unused memory."
333
+ tags: []
334
+ operationId: coreGc
335
+ parameters:
336
+ - $ref: "#/components/parameters/GlobalGroupParam"
337
+ - $ref: "#/components/parameters/GlobalAsyncParam"
338
+ responses:
339
+ "200":
340
+ $ref: "#/components/responses/EmptyObjectResponse"
341
+ "4XX":
342
+ $ref: "#/components/responses/RcError"
343
+ "5XX":
344
+ $ref: "#/components/responses/RcError"
345
+ /core/group-list:
346
+ post:
347
+ summary: "List stats groups"
348
+ description: "Lists stats groups currently tracked by rclone."
349
+ tags: []
350
+ operationId: coreGroupList
351
+ parameters:
352
+ - $ref: "#/components/parameters/GlobalGroupParam"
353
+ - $ref: "#/components/parameters/GlobalAsyncParam"
354
+ responses:
355
+ "200":
356
+ description: "Names of stats groups."
357
+ content:
358
+ application/json:
359
+ schema:
360
+ type: object
361
+ properties:
362
+ groups:
363
+ type: array
364
+ items:
365
+ type: string
366
+ required:
367
+ - groups
368
+ "4XX":
369
+ $ref: "#/components/responses/RcError"
370
+ "5XX":
371
+ $ref: "#/components/responses/RcError"
372
+ /core/memstats:
373
+ post:
374
+ summary: "Fetch runtime memory stats"
375
+ description: "Returns Go runtime memory statistics similar to `runtime.ReadMemStats`."
376
+ tags: []
377
+ operationId: coreMemstats
378
+ parameters:
379
+ - $ref: "#/components/parameters/GlobalGroupParam"
380
+ - $ref: "#/components/parameters/GlobalAsyncParam"
381
+ responses:
382
+ "200":
383
+ description: "Memory statistics fields from the Go runtime."
384
+ content:
385
+ application/json:
386
+ schema:
387
+ type: object
388
+ additionalProperties:
389
+ type: number
390
+ "4XX":
391
+ $ref: "#/components/responses/RcError"
392
+ "5XX":
393
+ $ref: "#/components/responses/RcError"
394
+ /core/obscure:
395
+ post:
396
+ summary: "Obscure a clear string"
397
+ description: "Obscures a plain-text secret for inclusion in `rclone.conf`."
398
+ tags: []
399
+ operationId: coreObscure
400
+ parameters:
401
+ - $ref: "#/components/parameters/Core_ObscurePostClearParam"
402
+ - $ref: "#/components/parameters/GlobalGroupParam"
403
+ - $ref: "#/components/parameters/GlobalAsyncParam"
404
+ responses:
405
+ "200":
406
+ description: "Obscured string result."
407
+ content:
408
+ application/json:
409
+ schema:
410
+ type: object
411
+ properties:
412
+ obscured:
413
+ type: string
414
+ required:
415
+ - obscured
416
+ "4XX":
417
+ $ref: "#/components/responses/RcError"
418
+ "5XX":
419
+ $ref: "#/components/responses/RcError"
420
+ /core/pid:
421
+ post:
422
+ summary: "Return rclone PID"
423
+ description: "Returns the process ID of the running rclone instance."
424
+ tags: []
425
+ operationId: corePid
426
+ parameters:
427
+ - $ref: "#/components/parameters/GlobalGroupParam"
428
+ - $ref: "#/components/parameters/GlobalAsyncParam"
429
+ responses:
430
+ "200":
431
+ description: "Process ID payload."
432
+ content:
433
+ application/json:
434
+ schema:
435
+ type: object
436
+ properties:
437
+ pid:
438
+ type: integer
439
+ required:
440
+ - pid
441
+ "4XX":
442
+ $ref: "#/components/responses/RcError"
443
+ "5XX":
444
+ $ref: "#/components/responses/RcError"
445
+ /core/quit:
446
+ post:
447
+ summary: "Terminate rclone"
448
+ description: "Stops the rclone process, optionally supplying an exit code."
449
+ tags: []
450
+ operationId: coreQuit
451
+ parameters:
452
+ - $ref: "#/components/parameters/Core_QuitPostExitCodeParam"
453
+ - $ref: "#/components/parameters/GlobalGroupParam"
454
+ - $ref: "#/components/parameters/GlobalAsyncParam"
455
+ responses:
456
+ "200":
457
+ $ref: "#/components/responses/EmptyObjectResponse"
458
+ "4XX":
459
+ $ref: "#/components/responses/RcError"
460
+ "5XX":
461
+ $ref: "#/components/responses/RcError"
462
+ /core/stats-delete:
463
+ post:
464
+ summary: "Delete stats group"
465
+ description: "Deletes the counters associated with a specific stats group."
466
+ tags: []
467
+ operationId: coreStatsDelete
468
+ parameters:
469
+ - $ref: "#/components/parameters/Core_StatsDeletePostGroupParam"
470
+ - $ref: "#/components/parameters/GlobalGroupParam"
471
+ - $ref: "#/components/parameters/GlobalAsyncParam"
472
+ responses:
473
+ "200":
474
+ $ref: "#/components/responses/EmptyObjectResponse"
475
+ "4XX":
476
+ $ref: "#/components/responses/RcError"
477
+ "5XX":
478
+ $ref: "#/components/responses/RcError"
479
+ /core/stats-reset:
480
+ post:
481
+ summary: "Reset stats counters"
482
+ description: "Clears counters, errors, and finished transfers for the provided stats group or all groups."
483
+ tags: []
484
+ operationId: coreStatsReset
485
+ parameters:
486
+ - $ref: "#/components/parameters/Core_StatsResetPostGroupParam"
487
+ - $ref: "#/components/parameters/GlobalGroupParam"
488
+ - $ref: "#/components/parameters/GlobalAsyncParam"
489
+ responses:
490
+ "200":
491
+ $ref: "#/components/responses/EmptyObjectResponse"
492
+ "4XX":
493
+ $ref: "#/components/responses/RcError"
494
+ "5XX":
495
+ $ref: "#/components/responses/RcError"
496
+ /core/transferred:
497
+ post:
498
+ summary: "List completed transfers"
499
+ description: "Returns up to 100 recently completed transfers for the requested stats group."
500
+ tags: []
501
+ operationId: coreTransferred
502
+ parameters:
503
+ - $ref: "#/components/parameters/Core_TransferredPostGroupParam"
504
+ - $ref: "#/components/parameters/GlobalGroupParam"
505
+ - $ref: "#/components/parameters/GlobalAsyncParam"
506
+ responses:
507
+ "200":
508
+ $ref: "#/components/responses/CoreTransferredResponse"
509
+ "4XX":
510
+ $ref: "#/components/responses/RcError"
511
+ "5XX":
512
+ $ref: "#/components/responses/RcError"
513
+ /debug/set-block-profile-rate:
514
+ post:
515
+ tags: []
516
+ operationId: debugSetBlockProfileRate
517
+ parameters:
518
+ - $ref: "#/components/parameters/Debug_SetBlockProfileRatePostRateParam"
519
+ - $ref: "#/components/parameters/GlobalGroupParam"
520
+ - $ref: "#/components/parameters/GlobalAsyncParam"
521
+ responses:
522
+ "200":
523
+ $ref: "#/components/responses/EmptyObjectResponse"
524
+ "4XX":
525
+ $ref: "#/components/responses/RcError"
526
+ "5XX":
527
+ $ref: "#/components/responses/RcError"
528
+ /debug/set-gc-percent:
529
+ post:
530
+ tags: []
531
+ operationId: debugSetGcPercent
532
+ parameters:
533
+ - $ref: "#/components/parameters/Debug_SetGcPercentPostGcPercentParam"
534
+ - $ref: "#/components/parameters/GlobalGroupParam"
535
+ - $ref: "#/components/parameters/GlobalAsyncParam"
536
+ responses:
537
+ "200":
538
+ $ref: "#/components/responses/DebugSetGcPercentResponse"
539
+ "4XX":
540
+ $ref: "#/components/responses/RcError"
541
+ "5XX":
542
+ $ref: "#/components/responses/RcError"
543
+ /debug/set-mutex-profile-fraction:
544
+ post:
545
+ tags: []
546
+ operationId: debugSetMutexProfileFraction
547
+ parameters:
548
+ - $ref: "#/components/parameters/Debug_SetMutexProfileFractionPostRateParam"
549
+ - $ref: "#/components/parameters/GlobalGroupParam"
550
+ - $ref: "#/components/parameters/GlobalAsyncParam"
551
+ responses:
552
+ "200":
553
+ $ref: "#/components/responses/DebugSetMutexProfileFractionResponse"
554
+ "4XX":
555
+ $ref: "#/components/responses/RcError"
556
+ "5XX":
557
+ $ref: "#/components/responses/RcError"
558
+ /debug/set-soft-memory-limit:
559
+ post:
560
+ tags: []
561
+ operationId: debugSetSoftMemoryLimit
562
+ parameters:
563
+ - $ref: "#/components/parameters/Debug_SetSoftMemoryLimitPostMemLimitParam"
564
+ - $ref: "#/components/parameters/GlobalGroupParam"
565
+ - $ref: "#/components/parameters/GlobalAsyncParam"
566
+ responses:
567
+ "200":
568
+ $ref: "#/components/responses/DebugSetSoftMemoryLimitResponse"
569
+ "4XX":
570
+ $ref: "#/components/responses/RcError"
571
+ "5XX":
572
+ $ref: "#/components/responses/RcError"
573
+ /fscache/clear:
574
+ post:
575
+ tags: []
576
+ operationId: fscacheClear
577
+ parameters:
578
+ - $ref: "#/components/parameters/GlobalGroupParam"
579
+ - $ref: "#/components/parameters/GlobalAsyncParam"
580
+ responses:
581
+ "200":
582
+ $ref: "#/components/responses/EmptyObjectResponse"
583
+ "4XX":
584
+ $ref: "#/components/responses/RcError"
585
+ "5XX":
586
+ $ref: "#/components/responses/RcError"
587
+ /fscache/entries:
588
+ post:
589
+ tags: []
590
+ operationId: fscacheEntries
591
+ parameters:
592
+ - $ref: "#/components/parameters/GlobalGroupParam"
593
+ - $ref: "#/components/parameters/GlobalAsyncParam"
594
+ responses:
595
+ "200":
596
+ $ref: "#/components/responses/FscacheEntriesResponse"
597
+ "4XX":
598
+ $ref: "#/components/responses/RcError"
599
+ "5XX":
600
+ $ref: "#/components/responses/RcError"
601
+ /mount/listmounts:
602
+ post:
603
+ tags: []
604
+ operationId: mountListmounts
605
+ parameters:
606
+ - $ref: "#/components/parameters/GlobalGroupParam"
607
+ - $ref: "#/components/parameters/GlobalAsyncParam"
608
+ responses:
609
+ "200":
610
+ $ref: "#/components/responses/MountListmountsResponse"
611
+ "4XX":
612
+ $ref: "#/components/responses/RcError"
613
+ "5XX":
614
+ $ref: "#/components/responses/RcError"
615
+ /mount/mount:
616
+ post:
617
+ tags: []
618
+ operationId: mountMount
619
+ parameters:
620
+ - $ref: "#/components/parameters/Mount_MountPostFsParam"
621
+ - $ref: "#/components/parameters/Mount_MountPostMountPointParam"
622
+ - $ref: "#/components/parameters/Mount_MountPostMountTypeParam"
623
+ - $ref: "#/components/parameters/Mount_MountPostMountOptParam"
624
+ - $ref: "#/components/parameters/Mount_MountPostVfsOptParam"
625
+ - $ref: "#/components/parameters/GlobalConfigParam"
626
+ - $ref: "#/components/parameters/GlobalFilterParam"
627
+ - $ref: "#/components/parameters/GlobalGroupParam"
628
+ - $ref: "#/components/parameters/GlobalAsyncParam"
629
+ responses:
630
+ "200":
631
+ $ref: "#/components/responses/EmptyObjectResponse"
632
+ "4XX":
633
+ $ref: "#/components/responses/RcError"
634
+ "5XX":
635
+ $ref: "#/components/responses/RcError"
636
+ /mount/types:
637
+ post:
638
+ tags: []
639
+ operationId: mountTypes
640
+ parameters:
641
+ - $ref: "#/components/parameters/GlobalGroupParam"
642
+ - $ref: "#/components/parameters/GlobalAsyncParam"
643
+ responses:
644
+ "200":
645
+ $ref: "#/components/responses/MountTypesResponse"
646
+ "4XX":
647
+ $ref: "#/components/responses/RcError"
648
+ "5XX":
649
+ $ref: "#/components/responses/RcError"
650
+ /mount/unmount:
651
+ post:
652
+ tags: []
653
+ operationId: mountUnmount
654
+ parameters:
655
+ - $ref: "#/components/parameters/Mount_UnmountPostMountPointParam"
656
+ - $ref: "#/components/parameters/GlobalGroupParam"
657
+ - $ref: "#/components/parameters/GlobalAsyncParam"
658
+ responses:
659
+ "200":
660
+ $ref: "#/components/responses/EmptyObjectResponse"
661
+ "4XX":
662
+ $ref: "#/components/responses/RcError"
663
+ "5XX":
664
+ $ref: "#/components/responses/RcError"
665
+ /mount/unmountall:
666
+ post:
667
+ tags: []
668
+ operationId: mountUnmountall
669
+ parameters:
670
+ - $ref: "#/components/parameters/GlobalGroupParam"
671
+ - $ref: "#/components/parameters/GlobalAsyncParam"
672
+ responses:
673
+ "200":
674
+ $ref: "#/components/responses/EmptyObjectResponse"
675
+ "4XX":
676
+ $ref: "#/components/responses/RcError"
677
+ "5XX":
678
+ $ref: "#/components/responses/RcError"
679
+ /rc/noopauth:
680
+ post:
681
+ summary: "Echo parameters (auth required)"
682
+ description: "Same as `rc/noop`, but requires authentication to validate access control."
683
+ tags: []
684
+ operationId: rcNoopAuth
685
+ parameters:
686
+ - $ref: "#/components/parameters/Rc_NoopauthPostAdditionalParam"
687
+ - $ref: "#/components/parameters/GlobalAsyncParam"
688
+ responses:
689
+ "200":
690
+ $ref: "#/components/responses/RcNoopResponse"
691
+ "4XX":
692
+ $ref: "#/components/responses/RcError"
693
+ "5XX":
694
+ $ref: "#/components/responses/RcError"
695
+ /rc/error:
696
+ post:
697
+ summary: "Return a test error"
698
+ description: "Always returns an error response incorporating the supplied parameters, useful for testing error handling."
699
+ tags: []
700
+ operationId: rcError
701
+ parameters:
702
+ - $ref: "#/components/parameters/Rc_ErrorPostAdditionalParam"
703
+ - $ref: "#/components/parameters/GlobalAsyncParam"
704
+ responses:
705
+ "200":
706
+ $ref: "#/components/responses/EmptyResponse"
707
+ "4XX":
708
+ $ref: "#/components/responses/RcError"
709
+ "5XX":
710
+ $ref: "#/components/responses/RcError"
711
+ /rc/list:
712
+ post:
713
+ summary: "List RC commands"
714
+ description: "Returns metadata about every available RC command, including whether authentication is required."
715
+ tags: []
716
+ operationId: rcList
717
+ parameters:
718
+ - $ref: "#/components/parameters/GlobalGroupParam"
719
+ - $ref: "#/components/parameters/GlobalAsyncParam"
720
+ responses:
721
+ "200":
722
+ $ref: "#/components/responses/RcListResponse"
723
+ "4XX":
724
+ $ref: "#/components/responses/RcError"
725
+ "5XX":
726
+ $ref: "#/components/responses/RcError"
727
+ /backend/command:
728
+ post:
729
+ summary: "Run backend command"
730
+ description: "Invokes a backend-specific management command against an optional remote."
731
+ tags: []
732
+ operationId: backendCommand
733
+ parameters:
734
+ - $ref: "#/components/parameters/Backend_CommandPostCommandParam"
735
+ - $ref: "#/components/parameters/Backend_CommandPostFsParam"
736
+ - $ref: "#/components/parameters/Backend_CommandPostArgParam"
737
+ - $ref: "#/components/parameters/Backend_CommandPostOptParam"
738
+ - $ref: "#/components/parameters/GlobalGroupParam"
739
+ - $ref: "#/components/parameters/GlobalAsyncParam"
740
+ responses:
741
+ "200":
742
+ $ref: "#/components/responses/BackendCommandResponse"
743
+ "4XX":
744
+ $ref: "#/components/responses/RcError"
745
+ "5XX":
746
+ $ref: "#/components/responses/RcError"
747
+ /cache/expire:
748
+ post:
749
+ summary: "Expire cache entries"
750
+ description: "Drops cached directory entries, and optionally cached file data, for the cache backend."
751
+ tags: []
752
+ operationId: cacheExpire
753
+ parameters:
754
+ - $ref: "#/components/parameters/Cache_ExpirePostRemoteParam"
755
+ - $ref: "#/components/parameters/Cache_ExpirePostWithDataParam"
756
+ - $ref: "#/components/parameters/GlobalGroupParam"
757
+ - $ref: "#/components/parameters/GlobalAsyncParam"
758
+ responses:
759
+ "200":
760
+ $ref: "#/components/responses/EmptyResponse"
761
+ "4XX":
762
+ $ref: "#/components/responses/RcError"
763
+ "5XX":
764
+ $ref: "#/components/responses/RcError"
765
+ /cache/fetch:
766
+ post:
767
+ summary: "Prefetch cache chunks"
768
+ description: "Ensures specified file chunks are cached locally for a cache remote."
769
+ tags: []
770
+ operationId: cacheFetch
771
+ parameters:
772
+ - $ref: "#/components/parameters/Cache_FetchPostChunksParam"
773
+ - $ref: "#/components/parameters/Cache_FetchPostAdditionalParam"
774
+ - $ref: "#/components/parameters/GlobalGroupParam"
775
+ - $ref: "#/components/parameters/GlobalAsyncParam"
776
+ responses:
777
+ "200":
778
+ $ref: "#/components/responses/EmptyResponse"
779
+ "4XX":
780
+ $ref: "#/components/responses/RcError"
781
+ "5XX":
782
+ $ref: "#/components/responses/RcError"
783
+ /cache/stats:
784
+ post:
785
+ summary: "Show cache stats"
786
+ description: "Returns runtime statistics for the cache backend."
787
+ tags: []
788
+ operationId: cacheStats
789
+ parameters:
790
+ - $ref: "#/components/parameters/GlobalGroupParam"
791
+ - $ref: "#/components/parameters/GlobalAsyncParam"
792
+ responses:
793
+ "200":
794
+ $ref: "#/components/responses/EmptyResponse"
795
+ "4XX":
796
+ $ref: "#/components/responses/RcError"
797
+ "5XX":
798
+ $ref: "#/components/responses/RcError"
799
+ /config/create:
800
+ post:
801
+ summary: "Create remote configuration"
802
+ description: "Creates a new remote in `rclone.conf`, mirroring `rclone config create`."
803
+ tags: []
804
+ operationId: configCreate
805
+ parameters:
806
+ - $ref: "#/components/parameters/Config_CreatePostNameParam"
807
+ - $ref: "#/components/parameters/Config_CreatePostParametersParam"
808
+ - $ref: "#/components/parameters/Config_CreatePostTypeParam"
809
+ - $ref: "#/components/parameters/Config_CreatePostOptParam"
810
+ - $ref: "#/components/parameters/GlobalGroupParam"
811
+ - $ref: "#/components/parameters/GlobalAsyncParam"
812
+ responses:
813
+ "200":
814
+ $ref: "#/components/responses/EmptyObjectResponse"
815
+ "4XX":
816
+ $ref: "#/components/responses/RcError"
817
+ "5XX":
818
+ $ref: "#/components/responses/RcError"
819
+ /config/delete:
820
+ post:
821
+ summary: "Delete remote configuration"
822
+ description: "Removes an existing remote from `rclone.conf`."
823
+ tags: []
824
+ operationId: configDelete
825
+ parameters:
826
+ - $ref: "#/components/parameters/Config_DeletePostNameParam"
827
+ - $ref: "#/components/parameters/GlobalGroupParam"
828
+ - $ref: "#/components/parameters/GlobalAsyncParam"
829
+ responses:
830
+ "200":
831
+ $ref: "#/components/responses/EmptyResponse"
832
+ "4XX":
833
+ $ref: "#/components/responses/RcError"
834
+ "5XX":
835
+ $ref: "#/components/responses/RcError"
836
+ /config/dump:
837
+ post:
838
+ summary: "Dump configuration"
839
+ description: "Returns the contents of the config file as a JSON object keyed by remote name."
840
+ tags: []
841
+ operationId: configDump
842
+ parameters:
843
+ - $ref: "#/components/parameters/GlobalGroupParam"
844
+ - $ref: "#/components/parameters/GlobalAsyncParam"
845
+ responses:
846
+ "200":
847
+ $ref: "#/components/responses/ConfigDumpResponse"
848
+ "4XX":
849
+ $ref: "#/components/responses/RcError"
850
+ "5XX":
851
+ $ref: "#/components/responses/RcError"
852
+ /config/get:
853
+ post:
854
+ summary: "Get remote configuration"
855
+ description: "Returns the key/value settings for a single remote."
856
+ tags: []
857
+ operationId: configGet
858
+ parameters:
859
+ - $ref: "#/components/parameters/Config_GetPostNameParam"
860
+ - $ref: "#/components/parameters/GlobalGroupParam"
861
+ - $ref: "#/components/parameters/GlobalAsyncParam"
862
+ responses:
863
+ "200":
864
+ $ref: "#/components/responses/ConfigGetResponse"
865
+ "4XX":
866
+ $ref: "#/components/responses/RcError"
867
+ "5XX":
868
+ $ref: "#/components/responses/RcError"
869
+ /config/listremotes:
870
+ post:
871
+ summary: "List configured remotes"
872
+ description: "Returns the names of all remotes defined in the config file."
873
+ tags: []
874
+ operationId: configListremotes
875
+ parameters:
876
+ - $ref: "#/components/parameters/GlobalGroupParam"
877
+ - $ref: "#/components/parameters/GlobalAsyncParam"
878
+ responses:
879
+ "200":
880
+ $ref: "#/components/responses/ConfigListremotesResponse"
881
+ "4XX":
882
+ $ref: "#/components/responses/RcError"
883
+ "5XX":
884
+ $ref: "#/components/responses/RcError"
885
+ /config/password:
886
+ post:
887
+ summary: "Update remote secrets"
888
+ description: "Sets obscured password fields for a remote configuration."
889
+ tags: []
890
+ operationId: configPassword
891
+ parameters:
892
+ - $ref: "#/components/parameters/Config_PasswordPostNameParam"
893
+ - $ref: "#/components/parameters/Config_PasswordPostParametersParam"
894
+ - $ref: "#/components/parameters/GlobalGroupParam"
895
+ - $ref: "#/components/parameters/GlobalAsyncParam"
896
+ responses:
897
+ "200":
898
+ $ref: "#/components/responses/EmptyResponse"
899
+ "4XX":
900
+ $ref: "#/components/responses/RcError"
901
+ "5XX":
902
+ $ref: "#/components/responses/RcError"
903
+ /config/paths:
904
+ post:
905
+ summary: "Show config paths"
906
+ description: "Returns the paths to the config file, cache directory, and temporary directory."
907
+ tags: []
908
+ operationId: configPaths
909
+ parameters:
910
+ - $ref: "#/components/parameters/GlobalGroupParam"
911
+ - $ref: "#/components/parameters/GlobalAsyncParam"
912
+ responses:
913
+ "200":
914
+ $ref: "#/components/responses/ConfigPathsResponse"
915
+ "4XX":
916
+ $ref: "#/components/responses/RcError"
917
+ "5XX":
918
+ $ref: "#/components/responses/RcError"
919
+ /config/providers:
920
+ post:
921
+ summary: "List backend providers"
922
+ description: "Returns metadata describing each supported storage provider."
923
+ tags: []
924
+ operationId: configProviders
925
+ parameters:
926
+ - $ref: "#/components/parameters/GlobalGroupParam"
927
+ - $ref: "#/components/parameters/GlobalAsyncParam"
928
+ responses:
929
+ "200":
930
+ $ref: "#/components/responses/ConfigProvidersResponse"
931
+ "4XX":
932
+ $ref: "#/components/responses/RcError"
933
+ "5XX":
934
+ $ref: "#/components/responses/RcError"
935
+ /config/setpath:
936
+ post:
937
+ summary: "Set config path"
938
+ description: "Points rclone at a specific `rclone.conf` file."
939
+ tags: []
940
+ operationId: configSetpath
941
+ parameters:
942
+ - $ref: "#/components/parameters/Config_SetpathPostPathParam"
943
+ - $ref: "#/components/parameters/GlobalGroupParam"
944
+ - $ref: "#/components/parameters/GlobalAsyncParam"
945
+ responses:
946
+ "200":
947
+ $ref: "#/components/responses/EmptyResponse"
948
+ "4XX":
949
+ $ref: "#/components/responses/RcError"
950
+ "5XX":
951
+ $ref: "#/components/responses/RcError"
952
+ /config/unlock:
953
+ post:
954
+ summary: "Unlock encrypted config"
955
+ description: "Unlocks the configuration file using the provided password."
956
+ tags: []
957
+ operationId: configUnlock
958
+ parameters:
959
+ - $ref: "#/components/parameters/Config_UnlockPostConfigPasswordParam"
960
+ - $ref: "#/components/parameters/GlobalGroupParam"
961
+ - $ref: "#/components/parameters/GlobalAsyncParam"
962
+ responses:
963
+ "200":
964
+ $ref: "#/components/responses/EmptyResponse"
965
+ "4XX":
966
+ $ref: "#/components/responses/RcError"
967
+ "5XX":
968
+ $ref: "#/components/responses/RcError"
969
+ /config/update:
970
+ post:
971
+ summary: "Update remote configuration"
972
+ description: "Updates an existing remote with new parameter values."
973
+ tags: []
974
+ operationId: configUpdate
975
+ parameters:
976
+ - $ref: "#/components/parameters/Config_UpdatePostNameParam"
977
+ - $ref: "#/components/parameters/Config_UpdatePostParametersParam"
978
+ - $ref: "#/components/parameters/Config_UpdatePostOptParam"
979
+ - $ref: "#/components/parameters/GlobalGroupParam"
980
+ - $ref: "#/components/parameters/GlobalAsyncParam"
981
+ responses:
982
+ "200":
983
+ $ref: "#/components/responses/EmptyObjectResponse"
984
+ "4XX":
985
+ $ref: "#/components/responses/RcError"
986
+ "5XX":
987
+ $ref: "#/components/responses/RcError"
988
+ /core/version:
989
+ post:
990
+ summary: "Report rclone version"
991
+ description: "Returns the running rclone version, build metadata, and Go runtime details."
992
+ tags: []
993
+ operationId: coreVersion
994
+ parameters:
995
+ - $ref: "#/components/parameters/GlobalGroupParam"
996
+ - $ref: "#/components/parameters/GlobalAsyncParam"
997
+ responses:
998
+ "200":
999
+ $ref: "#/components/responses/CoreVersionResponse"
1000
+ "4XX":
1001
+ $ref: "#/components/responses/RcError"
1002
+ "5XX":
1003
+ $ref: "#/components/responses/RcError"
1004
+ /core/stats:
1005
+ post:
1006
+ summary: "Current stats snapshot"
1007
+ description: "Returns active transfer statistics including bytes transferred, speed, and error counts."
1008
+ tags: []
1009
+ operationId: coreStats
1010
+ parameters:
1011
+ - $ref: "#/components/parameters/Core_StatsPostGroupParam"
1012
+ - $ref: "#/components/parameters/Core_StatsPostShortParam"
1013
+ - $ref: "#/components/parameters/GlobalGroupParam"
1014
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1015
+ responses:
1016
+ "200":
1017
+ $ref: "#/components/responses/CoreStatsResponse"
1018
+ "4XX":
1019
+ $ref: "#/components/responses/RcError"
1020
+ "5XX":
1021
+ $ref: "#/components/responses/RcError"
1022
+ /job/list:
1023
+ post:
1024
+ summary: "List jobs"
1025
+ description: "Returns identifiers of active and recently completed asynchronous jobs."
1026
+ tags: []
1027
+ operationId: jobList
1028
+ parameters:
1029
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1030
+ responses:
1031
+ "200":
1032
+ $ref: "#/components/responses/JobListResponse"
1033
+ "4XX":
1034
+ $ref: "#/components/responses/RcError"
1035
+ "5XX":
1036
+ $ref: "#/components/responses/RcError"
1037
+ /job/status:
1038
+ post:
1039
+ summary: "Get job status"
1040
+ description: "Returns timing, success state, output, and progress for a specific job."
1041
+ tags: []
1042
+ operationId: jobStatus
1043
+ parameters:
1044
+ - $ref: "#/components/parameters/Job_StatusPostJobidParam"
1045
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1046
+ responses:
1047
+ "200":
1048
+ $ref: "#/components/responses/JobStatusResponse"
1049
+ "4XX":
1050
+ $ref: "#/components/responses/RcError"
1051
+ "5XX":
1052
+ $ref: "#/components/responses/RcError"
1053
+ /job/stop:
1054
+ post:
1055
+ summary: "Stop job"
1056
+ description: "Attempts to cancel a running job by ID."
1057
+ tags: []
1058
+ operationId: jobStop
1059
+ parameters:
1060
+ - $ref: "#/components/parameters/Job_StopPostJobidParam"
1061
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1062
+ responses:
1063
+ "200":
1064
+ $ref: "#/components/responses/EmptyObjectResponse"
1065
+ "4XX":
1066
+ $ref: "#/components/responses/RcError"
1067
+ "5XX":
1068
+ $ref: "#/components/responses/RcError"
1069
+ /job/stopgroup:
1070
+ post:
1071
+ summary: "Stop jobs in group"
1072
+ description: "Cancels all active jobs associated with the provided stats group."
1073
+ tags: []
1074
+ operationId: jobStopgroup
1075
+ parameters:
1076
+ - $ref: "#/components/parameters/Job_StopgroupPostGroupParam"
1077
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1078
+ responses:
1079
+ "200":
1080
+ $ref: "#/components/responses/EmptyObjectResponse"
1081
+ "4XX":
1082
+ $ref: "#/components/responses/RcError"
1083
+ "5XX":
1084
+ $ref: "#/components/responses/RcError"
1085
+ /operations/list:
1086
+ post:
1087
+ summary: "List objects"
1088
+ description: "Lists objects and directories for a remote path, returning the same fields as `rclone lsjson`."
1089
+ tags: []
1090
+ operationId: operationsList
1091
+ parameters:
1092
+ - $ref: "#/components/parameters/Operations_ListPostFsParam"
1093
+ - $ref: "#/components/parameters/Operations_ListPostRemoteParam"
1094
+ - $ref: "#/components/parameters/Operations_ListPostOptParam"
1095
+ - $ref: "#/components/parameters/Operations_ListPostRecurseParam"
1096
+ - $ref: "#/components/parameters/Operations_ListPostNoModTimeParam"
1097
+ - $ref: "#/components/parameters/Operations_ListPostShowEncryptedParam"
1098
+ - $ref: "#/components/parameters/Operations_ListPostShowOrigIDsParam"
1099
+ - $ref: "#/components/parameters/Operations_ListPostShowHashParam"
1100
+ - $ref: "#/components/parameters/Operations_ListPostNoMimeTypeParam"
1101
+ - $ref: "#/components/parameters/Operations_ListPostDirsOnlyParam"
1102
+ - $ref: "#/components/parameters/Operations_ListPostFilesOnlyParam"
1103
+ - $ref: "#/components/parameters/Operations_ListPostMetadataParam"
1104
+ - $ref: "#/components/parameters/Operations_ListPostHashTypesParam"
1105
+ - $ref: "#/components/parameters/GlobalGroupParam"
1106
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1107
+ responses:
1108
+ "200":
1109
+ $ref: "#/components/responses/OperationsListResponse"
1110
+ "4XX":
1111
+ $ref: "#/components/responses/RcError"
1112
+ "5XX":
1113
+ $ref: "#/components/responses/RcError"
1114
+ /operations/stat:
1115
+ post:
1116
+ summary: "Stat an object"
1117
+ description: "Returns metadata for a single file or directory, mirroring `rclone lsjson` on one entry."
1118
+ tags: []
1119
+ operationId: operationsStat
1120
+ parameters:
1121
+ - $ref: "#/components/parameters/Operations_StatPostFsParam"
1122
+ - $ref: "#/components/parameters/Operations_StatPostRemoteParam"
1123
+ - $ref: "#/components/parameters/Operations_StatPostOptParam"
1124
+ - $ref: "#/components/parameters/GlobalGroupParam"
1125
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1126
+ responses:
1127
+ "200":
1128
+ $ref: "#/components/responses/OperationsStatResponse"
1129
+ "4XX":
1130
+ $ref: "#/components/responses/RcError"
1131
+ "5XX":
1132
+ $ref: "#/components/responses/RcError"
1133
+ /operations/about:
1134
+ post:
1135
+ summary: "Get remote quota"
1136
+ description: "Returns storage quota and usage details for the remote, equivalent to `rclone about`."
1137
+ tags: []
1138
+ operationId: operationsAbout
1139
+ parameters:
1140
+ - $ref: "#/components/parameters/Operations_AboutPostFsParam"
1141
+ - $ref: "#/components/parameters/GlobalGroupParam"
1142
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1143
+ responses:
1144
+ "200":
1145
+ $ref: "#/components/responses/OperationsAboutResponse"
1146
+ "4XX":
1147
+ $ref: "#/components/responses/RcError"
1148
+ "5XX":
1149
+ $ref: "#/components/responses/RcError"
1150
+ /operations/uploadfile:
1151
+ post:
1152
+ summary: "Upload files via multipart"
1153
+ description: "Accepts multipart/form-data payloads and writes the uploaded files to the specified remote path."
1154
+ tags: []
1155
+ operationId: operationsUploadfile
1156
+ parameters:
1157
+ - $ref: "#/components/parameters/Operations_UploadfilePostFsParam"
1158
+ - $ref: "#/components/parameters/Operations_UploadfilePostRemoteParam"
1159
+ - $ref: "#/components/parameters/GlobalGroupParam"
1160
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1161
+ requestBody:
1162
+ description: "Multipart form payload containing one or more files to upload."
1163
+ content:
1164
+ multipart/form-data:
1165
+ schema:
1166
+ nullable: true
1167
+ responses:
1168
+ "200":
1169
+ $ref: "#/components/responses/EmptyObjectResponse"
1170
+ "4XX":
1171
+ $ref: "#/components/responses/RcError"
1172
+ "5XX":
1173
+ $ref: "#/components/responses/RcError"
1174
+ /operations/purge:
1175
+ post:
1176
+ summary: "Purge directory"
1177
+ description: "Deletes a directory or container and all of its contents."
1178
+ tags: []
1179
+ operationId: operationsPurge
1180
+ parameters:
1181
+ - $ref: "#/components/parameters/Operations_PurgePostFsParam"
1182
+ - $ref: "#/components/parameters/Operations_PurgePostRemoteParam"
1183
+ - $ref: "#/components/parameters/GlobalConfigParam"
1184
+ - $ref: "#/components/parameters/GlobalFilterParam"
1185
+ - $ref: "#/components/parameters/GlobalGroupParam"
1186
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1187
+ responses:
1188
+ "200":
1189
+ $ref: "#/components/responses/EmptyObjectResponse"
1190
+ "4XX":
1191
+ $ref: "#/components/responses/RcError"
1192
+ "5XX":
1193
+ $ref: "#/components/responses/RcError"
1194
+ /operations/mkdir:
1195
+ post:
1196
+ summary: "Create directory"
1197
+ description: "Creates the target directory or container if it does not exist."
1198
+ tags: []
1199
+ operationId: operationsMkdir
1200
+ parameters:
1201
+ - $ref: "#/components/parameters/Operations_MkdirPostFsParam"
1202
+ - $ref: "#/components/parameters/Operations_MkdirPostRemoteParam"
1203
+ - $ref: "#/components/parameters/GlobalGroupParam"
1204
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1205
+ responses:
1206
+ "200":
1207
+ $ref: "#/components/responses/EmptyObjectResponse"
1208
+ "4XX":
1209
+ $ref: "#/components/responses/RcError"
1210
+ "5XX":
1211
+ $ref: "#/components/responses/RcError"
1212
+ /operations/rmdir:
1213
+ post:
1214
+ summary: "Remove empty directory"
1215
+ description: "Deletes an empty directory or container."
1216
+ tags: []
1217
+ operationId: operationsRmdir
1218
+ parameters:
1219
+ - $ref: "#/components/parameters/Operations_RmdirPostFsParam"
1220
+ - $ref: "#/components/parameters/Operations_RmdirPostRemoteParam"
1221
+ - $ref: "#/components/parameters/GlobalGroupParam"
1222
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1223
+ responses:
1224
+ "200":
1225
+ $ref: "#/components/responses/EmptyObjectResponse"
1226
+ "4XX":
1227
+ $ref: "#/components/responses/RcError"
1228
+ "5XX":
1229
+ $ref: "#/components/responses/RcError"
1230
+ /operations/check:
1231
+ post:
1232
+ summary: "Compare source and destination"
1233
+ description: "Compares source and destination trees, reporting matches, differences, and missing files."
1234
+ tags: []
1235
+ operationId: operationsCheck
1236
+ parameters:
1237
+ - $ref: "#/components/parameters/Operations_CheckPostSrcFsParam"
1238
+ - $ref: "#/components/parameters/Operations_CheckPostDstFsParam"
1239
+ - $ref: "#/components/parameters/Operations_CheckPostDownloadParam"
1240
+ - $ref: "#/components/parameters/Operations_CheckPostCheckFileHashParam"
1241
+ - $ref: "#/components/parameters/Operations_CheckPostCheckFileFsParam"
1242
+ - $ref: "#/components/parameters/Operations_CheckPostCheckFileRemoteParam"
1243
+ - $ref: "#/components/parameters/Operations_CheckPostOneWayParam"
1244
+ - $ref: "#/components/parameters/Operations_CheckPostCombinedParam"
1245
+ - $ref: "#/components/parameters/Operations_CheckPostMissingOnSrcParam"
1246
+ - $ref: "#/components/parameters/Operations_CheckPostMissingOnDstParam"
1247
+ - $ref: "#/components/parameters/Operations_CheckPostMatchParam"
1248
+ - $ref: "#/components/parameters/Operations_CheckPostDifferParam"
1249
+ - $ref: "#/components/parameters/Operations_CheckPostErrorParam"
1250
+ - $ref: "#/components/parameters/GlobalGroupParam"
1251
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1252
+ responses:
1253
+ "200":
1254
+ $ref: "#/components/responses/OperationsCheckResponse"
1255
+ "4XX":
1256
+ $ref: "#/components/responses/RcError"
1257
+ "5XX":
1258
+ $ref: "#/components/responses/RcError"
1259
+ /sync/sync:
1260
+ post:
1261
+ summary: "Sync source to destination"
1262
+ description: "Synchronises a source remote to a destination remote, making the destination match the source."
1263
+ tags: []
1264
+ operationId: syncSync
1265
+ parameters:
1266
+ - $ref: "#/components/parameters/Sync_SyncPostSrcFsParam"
1267
+ - $ref: "#/components/parameters/Sync_SyncPostDstFsParam"
1268
+ - $ref: "#/components/parameters/Sync_SyncPostCreateEmptySrcDirsParam"
1269
+ - $ref: "#/components/parameters/GlobalConfigParam"
1270
+ - $ref: "#/components/parameters/GlobalFilterParam"
1271
+ - $ref: "#/components/parameters/GlobalGroupParam"
1272
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1273
+ responses:
1274
+ "200":
1275
+ $ref: "#/components/responses/EmptyObjectResponse"
1276
+ "4XX":
1277
+ $ref: "#/components/responses/RcError"
1278
+ "5XX":
1279
+ $ref: "#/components/responses/RcError"
1280
+ /sync/copy:
1281
+ post:
1282
+ summary: "Copy source to destination"
1283
+ description: "Copies objects from a source remote to a destination remote without deleting destination files."
1284
+ tags: []
1285
+ operationId: syncCopy
1286
+ parameters:
1287
+ - $ref: "#/components/parameters/Sync_CopyPostSrcFsParam"
1288
+ - $ref: "#/components/parameters/Sync_CopyPostDstFsParam"
1289
+ - $ref: "#/components/parameters/Sync_CopyPostCreateEmptySrcDirsParam"
1290
+ - $ref: "#/components/parameters/GlobalConfigParam"
1291
+ - $ref: "#/components/parameters/GlobalFilterParam"
1292
+ - $ref: "#/components/parameters/GlobalGroupParam"
1293
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1294
+ responses:
1295
+ "200":
1296
+ $ref: "#/components/responses/EmptyObjectResponse"
1297
+ "4XX":
1298
+ $ref: "#/components/responses/RcError"
1299
+ "5XX":
1300
+ $ref: "#/components/responses/RcError"
1301
+ /sync/move:
1302
+ post:
1303
+ summary: "Move source to destination"
1304
+ description: "Moves objects from a source remote to a destination remote, optionally cleaning up empty directories."
1305
+ tags: []
1306
+ operationId: syncMove
1307
+ parameters:
1308
+ - $ref: "#/components/parameters/Sync_MovePostSrcFsParam"
1309
+ - $ref: "#/components/parameters/Sync_MovePostDstFsParam"
1310
+ - $ref: "#/components/parameters/Sync_MovePostCreateEmptySrcDirsParam"
1311
+ - $ref: "#/components/parameters/Sync_MovePostDeleteEmptySrcDirsParam"
1312
+ - $ref: "#/components/parameters/GlobalConfigParam"
1313
+ - $ref: "#/components/parameters/GlobalFilterParam"
1314
+ - $ref: "#/components/parameters/GlobalGroupParam"
1315
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1316
+ responses:
1317
+ "200":
1318
+ $ref: "#/components/responses/EmptyObjectResponse"
1319
+ "4XX":
1320
+ $ref: "#/components/responses/RcError"
1321
+ "5XX":
1322
+ $ref: "#/components/responses/RcError"
1323
+ /sync/bisync:
1324
+ post:
1325
+ summary: "Bidirectional sync"
1326
+ description: "Performs a bidirectional synchronisation between two paths, supporting safety checks and recovery options."
1327
+ tags: []
1328
+ operationId: syncBisync
1329
+ parameters:
1330
+ - $ref: "#/components/parameters/Sync_BisyncPostPath1Param"
1331
+ - $ref: "#/components/parameters/Sync_BisyncPostPath2Param"
1332
+ - $ref: "#/components/parameters/Sync_BisyncPostDryRunParam"
1333
+ - $ref: "#/components/parameters/Sync_BisyncPostResyncParam"
1334
+ - $ref: "#/components/parameters/Sync_BisyncPostCheckAccessParam"
1335
+ - $ref: "#/components/parameters/Sync_BisyncPostCheckFilenameParam"
1336
+ - $ref: "#/components/parameters/Sync_BisyncPostMaxDeleteParam"
1337
+ - $ref: "#/components/parameters/Sync_BisyncPostForceParam"
1338
+ - $ref: "#/components/parameters/Sync_BisyncPostCheckSyncParam"
1339
+ - $ref: "#/components/parameters/Sync_BisyncPostCreateEmptySrcDirsParam"
1340
+ - $ref: "#/components/parameters/Sync_BisyncPostRemoveEmptyDirsParam"
1341
+ - $ref: "#/components/parameters/Sync_BisyncPostFiltersFileParam"
1342
+ - $ref: "#/components/parameters/Sync_BisyncPostIgnoreListingChecksumParam"
1343
+ - $ref: "#/components/parameters/Sync_BisyncPostResilientParam"
1344
+ - $ref: "#/components/parameters/Sync_BisyncPostWorkdirParam"
1345
+ - $ref: "#/components/parameters/Sync_BisyncPostBackupdir1Param"
1346
+ - $ref: "#/components/parameters/Sync_BisyncPostBackupdir2Param"
1347
+ - $ref: "#/components/parameters/Sync_BisyncPostNoCleanupParam"
1348
+ - $ref: "#/components/parameters/GlobalConfigParam"
1349
+ - $ref: "#/components/parameters/GlobalFilterParam"
1350
+ - $ref: "#/components/parameters/GlobalGroupParam"
1351
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1352
+ responses:
1353
+ "200":
1354
+ $ref: "#/components/responses/EmptyObjectResponse"
1355
+ "4XX":
1356
+ $ref: "#/components/responses/RcError"
1357
+ "5XX":
1358
+ $ref: "#/components/responses/RcError"
1359
+ /options/blocks:
1360
+ post:
1361
+ summary: "List option blocks"
1362
+ description: "Returns the names of option blocks that can be queried or updated."
1363
+ tags: []
1364
+ operationId: optionsBlocks
1365
+ parameters:
1366
+ - $ref: "#/components/parameters/GlobalGroupParam"
1367
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1368
+ responses:
1369
+ "200":
1370
+ $ref: "#/components/responses/OptionsBlocksResponse"
1371
+ "4XX":
1372
+ $ref: "#/components/responses/RcError"
1373
+ "5XX":
1374
+ $ref: "#/components/responses/RcError"
1375
+ /options/get:
1376
+ post:
1377
+ summary: "Get option values"
1378
+ description: "Returns the current global option values, optionally filtered by block."
1379
+ tags: []
1380
+ operationId: optionsGet
1381
+ parameters:
1382
+ - $ref: "#/components/parameters/Options_GetPostBlocksParam"
1383
+ - $ref: "#/components/parameters/GlobalGroupParam"
1384
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1385
+ responses:
1386
+ "200":
1387
+ $ref: "#/components/responses/OptionsGetResponse"
1388
+ "4XX":
1389
+ $ref: "#/components/responses/RcError"
1390
+ "5XX":
1391
+ $ref: "#/components/responses/RcError"
1392
+ /options/info:
1393
+ post:
1394
+ summary: "Describe options"
1395
+ description: "Returns metadata for options, including help text and defaults, grouped by block."
1396
+ tags: []
1397
+ operationId: optionsInfo
1398
+ parameters:
1399
+ - $ref: "#/components/parameters/Options_InfoPostBlocksParam"
1400
+ - $ref: "#/components/parameters/GlobalGroupParam"
1401
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1402
+ responses:
1403
+ "200":
1404
+ $ref: "#/components/responses/OptionsInfoResponse"
1405
+ "4XX":
1406
+ $ref: "#/components/responses/RcError"
1407
+ "5XX":
1408
+ $ref: "#/components/responses/RcError"
1409
+ /options/set:
1410
+ post:
1411
+ summary: "Set option values"
1412
+ description: >
1413
+ Sets temporary option overrides for the running process by supplying key/value
1414
+ pairs grouped under option block names. Provide one or more query parameters
1415
+ whose names match the blocks you want to modify (for example `main`, `rc`,
1416
+ `http`). Each block parameter carries an object of option overrides.
1417
+ tags: []
1418
+ operationId: optionsSet
1419
+ x-additionalQueryBlocksAllowed: true
1420
+ parameters:
1421
+ - $ref: "#/components/parameters/Options_SetPostDlnaParam"
1422
+ - $ref: "#/components/parameters/Options_SetPostFilterParam"
1423
+ - $ref: "#/components/parameters/Options_SetPostFtpParam"
1424
+ - $ref: "#/components/parameters/Options_SetPostMainParam"
1425
+ - $ref: "#/components/parameters/Options_SetPostHttpParam"
1426
+ - $ref: "#/components/parameters/Options_SetPostLogParam"
1427
+ - $ref: "#/components/parameters/Options_SetPostMountParam"
1428
+ - $ref: "#/components/parameters/Options_SetPostNfsParam"
1429
+ - $ref: "#/components/parameters/Options_SetPostProxyParam"
1430
+ - $ref: "#/components/parameters/Options_SetPostRcParam"
1431
+ - $ref: "#/components/parameters/Options_SetPostResticParam"
1432
+ - $ref: "#/components/parameters/Options_SetPostS3Param"
1433
+ - $ref: "#/components/parameters/Options_SetPostSftpParam"
1434
+ - $ref: "#/components/parameters/Options_SetPostVfsParam"
1435
+ - $ref: "#/components/parameters/Options_SetPostWebdavParam"
1436
+ - $ref: "#/components/parameters/GlobalGroupParam"
1437
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1438
+ responses:
1439
+ "200":
1440
+ $ref: "#/components/responses/EmptyObjectResponse"
1441
+ "4XX":
1442
+ $ref: "#/components/responses/RcError"
1443
+ "5XX":
1444
+ $ref: "#/components/responses/RcError"
1445
+ /options/local:
1446
+ post:
1447
+ summary: "Show effective options"
1448
+ description: "Returns the current effective options for this request, including `_config` and `_filter` overrides."
1449
+ tags: []
1450
+ operationId: optionsLocal
1451
+ parameters:
1452
+ - $ref: "#/components/parameters/GlobalGroupParam"
1453
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1454
+ responses:
1455
+ "200":
1456
+ $ref: "#/components/responses/OptionsLocalResponse"
1457
+ "4XX":
1458
+ $ref: "#/components/responses/RcError"
1459
+ "5XX":
1460
+ $ref: "#/components/responses/RcError"
1461
+ /serve/list:
1462
+ post:
1463
+ summary: "List serve instances"
1464
+ description: "Returns all running `rclone serve` instances with their IDs and options."
1465
+ tags: []
1466
+ operationId: serveList
1467
+ parameters:
1468
+ - $ref: "#/components/parameters/GlobalGroupParam"
1469
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1470
+ responses:
1471
+ "200":
1472
+ $ref: "#/components/responses/ServeListResponse"
1473
+ "4XX":
1474
+ $ref: "#/components/responses/RcError"
1475
+ "5XX":
1476
+ $ref: "#/components/responses/RcError"
1477
+ /serve/start:
1478
+ post:
1479
+ summary: "Start serve instance"
1480
+ description: "Launches a new `rclone serve` endpoint (http, webdav, ftp, etc.) with the provided parameters."
1481
+ tags: []
1482
+ operationId: serveStart
1483
+ parameters:
1484
+ - $ref: "#/components/parameters/Serve_StartPostTypeParam"
1485
+ - $ref: "#/components/parameters/Serve_StartPostFsParam"
1486
+ - $ref: "#/components/parameters/Serve_StartPostAddrParam"
1487
+ - $ref: "#/components/parameters/Serve_StartPostAdditionalParam"
1488
+ - $ref: "#/components/parameters/GlobalConfigParam"
1489
+ - $ref: "#/components/parameters/GlobalFilterParam"
1490
+ - $ref: "#/components/parameters/GlobalGroupParam"
1491
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1492
+ responses:
1493
+ "200":
1494
+ $ref: "#/components/responses/ServeStartResponse"
1495
+ "4XX":
1496
+ $ref: "#/components/responses/RcError"
1497
+ "5XX":
1498
+ $ref: "#/components/responses/RcError"
1499
+ /serve/stop:
1500
+ post:
1501
+ summary: "Stop serve instance"
1502
+ description: "Stops a running `serve` instance identified by its ID."
1503
+ tags: []
1504
+ operationId: serveStop
1505
+ parameters:
1506
+ - $ref: "#/components/parameters/Serve_StopPostIdParam"
1507
+ - $ref: "#/components/parameters/GlobalGroupParam"
1508
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1509
+ responses:
1510
+ "200":
1511
+ $ref: "#/components/responses/EmptyObjectResponse"
1512
+ "4XX":
1513
+ $ref: "#/components/responses/RcError"
1514
+ "5XX":
1515
+ $ref: "#/components/responses/RcError"
1516
+ /serve/stopall:
1517
+ post:
1518
+ summary: "Stop all serve instances"
1519
+ description: "Stops every active `serve` instance."
1520
+ tags: []
1521
+ operationId: serveStopall
1522
+ parameters:
1523
+ - $ref: "#/components/parameters/GlobalGroupParam"
1524
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1525
+ responses:
1526
+ "200":
1527
+ $ref: "#/components/responses/EmptyObjectResponse"
1528
+ "4XX":
1529
+ $ref: "#/components/responses/RcError"
1530
+ "5XX":
1531
+ $ref: "#/components/responses/RcError"
1532
+ /serve/types:
1533
+ post:
1534
+ summary: "List serve types"
1535
+ description: "Returns the list of supported `rclone serve` protocols."
1536
+ tags: []
1537
+ operationId: serveTypes
1538
+ parameters:
1539
+ - $ref: "#/components/parameters/GlobalGroupParam"
1540
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1541
+ responses:
1542
+ "200":
1543
+ $ref: "#/components/responses/EmptyResponse"
1544
+ "4XX":
1545
+ $ref: "#/components/responses/RcError"
1546
+ "5XX":
1547
+ $ref: "#/components/responses/RcError"
1548
+ /vfs/forget:
1549
+ post:
1550
+ summary: "Forget cached paths"
1551
+ description: "Evicts specific files or directories from the VFS directory cache."
1552
+ tags: []
1553
+ operationId: vfsForget
1554
+ parameters:
1555
+ - $ref: "#/components/parameters/Vfs_ForgetPostFsParam"
1556
+ - $ref: "#/components/parameters/Vfs_ForgetPostAdditionalParam"
1557
+ - $ref: "#/components/parameters/GlobalGroupParam"
1558
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1559
+ responses:
1560
+ "200":
1561
+ $ref: "#/components/responses/VfsForgetResponse"
1562
+ "4XX":
1563
+ $ref: "#/components/responses/RcError"
1564
+ "5XX":
1565
+ $ref: "#/components/responses/RcError"
1566
+ /vfs/list:
1567
+ post:
1568
+ summary: "List VFS instances"
1569
+ description: "Lists the active VFS instances and their identifiers."
1570
+ tags: []
1571
+ operationId: vfsList
1572
+ parameters:
1573
+ - $ref: "#/components/parameters/Vfs_ListPostFsParam"
1574
+ - $ref: "#/components/parameters/GlobalGroupParam"
1575
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1576
+ responses:
1577
+ "200":
1578
+ $ref: "#/components/responses/VfsListResponse"
1579
+ "4XX":
1580
+ $ref: "#/components/responses/RcError"
1581
+ "5XX":
1582
+ $ref: "#/components/responses/RcError"
1583
+ /vfs/poll-interval:
1584
+ post:
1585
+ summary: "Get or set poll interval"
1586
+ description: "Reads or updates the VFS poll interval duration, optionally waiting for the change to apply."
1587
+ tags: []
1588
+ operationId: vfsPollInterval
1589
+ parameters:
1590
+ - $ref: "#/components/parameters/Vfs_PollIntervalPostFsParam"
1591
+ - $ref: "#/components/parameters/Vfs_PollIntervalPostIntervalParam"
1592
+ - $ref: "#/components/parameters/Vfs_PollIntervalPostTimeoutParam"
1593
+ - $ref: "#/components/parameters/GlobalGroupParam"
1594
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1595
+ responses:
1596
+ "200":
1597
+ $ref: "#/components/responses/VfsPollIntervalResponse"
1598
+ "4XX":
1599
+ $ref: "#/components/responses/RcError"
1600
+ "5XX":
1601
+ $ref: "#/components/responses/RcError"
1602
+ /vfs/queue:
1603
+ post:
1604
+ summary: "Inspect upload queue"
1605
+ description: "Returns the contents of the VFS upload queue."
1606
+ tags: []
1607
+ operationId: vfsQueue
1608
+ parameters:
1609
+ - $ref: "#/components/parameters/Vfs_QueuePostFsParam"
1610
+ - $ref: "#/components/parameters/GlobalGroupParam"
1611
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1612
+ responses:
1613
+ "200":
1614
+ $ref: "#/components/responses/VfsQueueResponse"
1615
+ "4XX":
1616
+ $ref: "#/components/responses/RcError"
1617
+ "5XX":
1618
+ $ref: "#/components/responses/RcError"
1619
+ /vfs/queue-set-expiry:
1620
+ post:
1621
+ summary: "Adjust queue expiry"
1622
+ description: "Sets the expiry time of a queued VFS upload item, optionally relative to its current value."
1623
+ tags: []
1624
+ operationId: vfsQueueSetExpiry
1625
+ parameters:
1626
+ - $ref: "#/components/parameters/Vfs_QueueSetExpiryPostFsParam"
1627
+ - $ref: "#/components/parameters/Vfs_QueueSetExpiryPostIdParam"
1628
+ - $ref: "#/components/parameters/Vfs_QueueSetExpiryPostExpiryParam"
1629
+ - $ref: "#/components/parameters/Vfs_QueueSetExpiryPostRelativeParam"
1630
+ - $ref: "#/components/parameters/GlobalGroupParam"
1631
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1632
+ responses:
1633
+ "200":
1634
+ $ref: "#/components/responses/EmptyObjectResponse"
1635
+ "4XX":
1636
+ $ref: "#/components/responses/RcError"
1637
+ "5XX":
1638
+ $ref: "#/components/responses/RcError"
1639
+ /vfs/refresh:
1640
+ post:
1641
+ summary: "Refresh directory cache"
1642
+ description: "Refreshes one or more directories in the VFS cache, optionally recursively."
1643
+ tags: []
1644
+ operationId: vfsRefresh
1645
+ parameters:
1646
+ - $ref: "#/components/parameters/Vfs_RefreshPostFsParam"
1647
+ - $ref: "#/components/parameters/Vfs_RefreshPostRecursiveParam"
1648
+ - $ref: "#/components/parameters/Vfs_RefreshPostAdditionalParam"
1649
+ - $ref: "#/components/parameters/GlobalGroupParam"
1650
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1651
+ responses:
1652
+ "200":
1653
+ $ref: "#/components/responses/VfsRefreshResponse"
1654
+ "4XX":
1655
+ $ref: "#/components/responses/RcError"
1656
+ "5XX":
1657
+ $ref: "#/components/responses/RcError"
1658
+ /vfs/stats:
1659
+ post:
1660
+ summary: "Show VFS stats"
1661
+ description: "Returns VFS statistics including disk cache usage and metadata cache counters."
1662
+ tags: []
1663
+ operationId: vfsStats
1664
+ parameters:
1665
+ - $ref: "#/components/parameters/Vfs_StatsPostFsParam"
1666
+ - $ref: "#/components/parameters/GlobalGroupParam"
1667
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1668
+ responses:
1669
+ "200":
1670
+ $ref: "#/components/responses/VfsStatsResponse"
1671
+ "4XX":
1672
+ $ref: "#/components/responses/RcError"
1673
+ "5XX":
1674
+ $ref: "#/components/responses/RcError"
1675
+ /pluginsctl/addPlugin:
1676
+ post:
1677
+ summary: "Install plugin"
1678
+ description: "Downloads and installs a plugin into the WebUI from the provided repository URL."
1679
+ tags: []
1680
+ operationId: pluginsctlAddPlugin
1681
+ parameters:
1682
+ - $ref: "#/components/parameters/Pluginsctl_AddPluginPostUrlParam"
1683
+ - $ref: "#/components/parameters/GlobalGroupParam"
1684
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1685
+ responses:
1686
+ "200":
1687
+ $ref: "#/components/responses/EmptyObjectResponse"
1688
+ "4XX":
1689
+ $ref: "#/components/responses/RcError"
1690
+ "5XX":
1691
+ $ref: "#/components/responses/RcError"
1692
+ /pluginsctl/getPluginsForType:
1693
+ post:
1694
+ summary: "Filter plugins by MIME type"
1695
+ description: "Returns plugins matching the requested MIME type and optional plugin type."
1696
+ tags: []
1697
+ operationId: pluginsctlGetPluginsForType
1698
+ parameters:
1699
+ - $ref: "#/components/parameters/Pluginsctl_GetPluginsForTypePostTypeParam"
1700
+ - $ref: "#/components/parameters/Pluginsctl_GetPluginsForTypePostPluginTypeParam"
1701
+ - $ref: "#/components/parameters/GlobalGroupParam"
1702
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1703
+ responses:
1704
+ "200":
1705
+ $ref: "#/components/responses/PluginsctlGetPluginsForTypeResponse"
1706
+ "4XX":
1707
+ $ref: "#/components/responses/RcError"
1708
+ "5XX":
1709
+ $ref: "#/components/responses/RcError"
1710
+ /pluginsctl/listPlugins:
1711
+ post:
1712
+ summary: "List installed plugins"
1713
+ description: "Returns metadata for installed production and test plugins."
1714
+ tags: []
1715
+ operationId: pluginsctlListPlugins
1716
+ parameters:
1717
+ - $ref: "#/components/parameters/GlobalGroupParam"
1718
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1719
+ responses:
1720
+ "200":
1721
+ $ref: "#/components/responses/PluginsctlListPluginsResponse"
1722
+ "4XX":
1723
+ $ref: "#/components/responses/RcError"
1724
+ "5XX":
1725
+ $ref: "#/components/responses/RcError"
1726
+ /pluginsctl/listTestPlugins:
1727
+ post:
1728
+ summary: "List installed test plugins"
1729
+ description: "Returns metadata for installed test plugins."
1730
+ tags: []
1731
+ operationId: pluginsctlListTestPlugins
1732
+ parameters:
1733
+ - $ref: "#/components/parameters/GlobalGroupParam"
1734
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1735
+ responses:
1736
+ "200":
1737
+ $ref: "#/components/responses/PluginsctlListTestPluginsResponse"
1738
+ "4XX":
1739
+ $ref: "#/components/responses/RcError"
1740
+ "5XX":
1741
+ $ref: "#/components/responses/RcError"
1742
+ /pluginsctl/removePlugin:
1743
+ post:
1744
+ summary: "Remove plugin"
1745
+ description: "Uninstalls a plugin from the WebUI."
1746
+ tags: []
1747
+ operationId: pluginsctlRemovePlugin
1748
+ parameters:
1749
+ - $ref: "#/components/parameters/Pluginsctl_RemovePluginPostNameParam"
1750
+ - $ref: "#/components/parameters/GlobalGroupParam"
1751
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1752
+ responses:
1753
+ "200":
1754
+ $ref: "#/components/responses/EmptyResponse"
1755
+ "4XX":
1756
+ $ref: "#/components/responses/RcError"
1757
+ "5XX":
1758
+ $ref: "#/components/responses/RcError"
1759
+ /pluginsctl/removeTestPlugin:
1760
+ post:
1761
+ summary: "Remove test plugin"
1762
+ description: "Uninstalls a test plugin from the WebUI."
1763
+ tags: []
1764
+ operationId: pluginsctlRemoveTestPlugin
1765
+ parameters:
1766
+ - $ref: "#/components/parameters/Pluginsctl_RemoveTestPluginPostNameParam"
1767
+ - $ref: "#/components/parameters/GlobalGroupParam"
1768
+ - $ref: "#/components/parameters/GlobalAsyncParam"
1769
+ responses:
1770
+ "200":
1771
+ $ref: "#/components/responses/EmptyResponse"
1772
+ "4XX":
1773
+ $ref: "#/components/responses/RcError"
1774
+ "5XX":
1775
+ $ref: "#/components/responses/RcError"
1776
+ components:
1777
+ parameters:
1778
+ GlobalAsyncParam:
1779
+ name: _async
1780
+ in: query
1781
+ description: Run the command asynchronously. Returns a job id immediately.
1782
+ schema:
1783
+ type: boolean
1784
+ GlobalConfigParam:
1785
+ name: _config
1786
+ in: query
1787
+ description: JSON encoded config overrides applied for this call only.
1788
+ schema:
1789
+ type: string
1790
+ GlobalFilterParam:
1791
+ name: _filter
1792
+ in: query
1793
+ description: JSON encoded filter overrides applied for this call only.
1794
+ schema:
1795
+ type: string
1796
+ GlobalGroupParam:
1797
+ name: _group
1798
+ in: query
1799
+ description: Assign the request to a custom stats group.
1800
+ schema:
1801
+ type: string
1802
+ Rc_NoopPostAdditionalParam:
1803
+ name: params
1804
+ in: query
1805
+ description: Additional arbitrary parameters allowed.
1806
+ schema:
1807
+ type: object
1808
+ style: form
1809
+ explode: true
1810
+ Operations_CleanupPostFsParam:
1811
+ name: fs
1812
+ in: query
1813
+ description: "Remote name or path to clean up, for example `drive:`."
1814
+ schema:
1815
+ type: string
1816
+ required: true
1817
+ Operations_CopyfilePostSrcFsParam:
1818
+ name: srcFs
1819
+ in: query
1820
+ description: "Source remote name or path, such as `drive:` or `/` for the local filesystem."
1821
+ schema:
1822
+ type: string
1823
+ required: true
1824
+ Operations_CopyfilePostSrcRemoteParam:
1825
+ name: srcRemote
1826
+ in: query
1827
+ description: "Path to the source object within `srcFs`, for example `dir/file.txt`."
1828
+ schema:
1829
+ type: string
1830
+ required: true
1831
+ Operations_CopyfilePostDstFsParam:
1832
+ name: dstFs
1833
+ in: query
1834
+ description: "Destination remote name or path, such as `drive2:` or `/` for local filesystem."
1835
+ schema:
1836
+ type: string
1837
+ required: true
1838
+ Operations_CopyfilePostDstRemoteParam:
1839
+ name: dstRemote
1840
+ in: query
1841
+ description: "Target path within `dstFs` where the file should be written."
1842
+ schema:
1843
+ type: string
1844
+ required: true
1845
+ Operations_CopyurlPostFsParam:
1846
+ name: fs
1847
+ in: query
1848
+ description: "Remote name or path that will receive the downloaded file, e.g. `drive:`."
1849
+ schema:
1850
+ type: string
1851
+ required: true
1852
+ Operations_CopyurlPostRemoteParam:
1853
+ name: remote
1854
+ in: query
1855
+ description: "Destination path within `fs` where the fetched object will be stored."
1856
+ schema:
1857
+ type: string
1858
+ required: true
1859
+ Operations_CopyurlPostUrlParam:
1860
+ name: url
1861
+ in: query
1862
+ description: "Source URL to fetch the object from."
1863
+ schema:
1864
+ type: string
1865
+ required: true
1866
+ Operations_CopyurlPostAutoFilenameParam:
1867
+ name: autoFilename
1868
+ in: query
1869
+ description: "Set to true to derive the destination filename from the URL."
1870
+ schema:
1871
+ type: boolean
1872
+ Operations_DeletePostFsParam:
1873
+ name: fs
1874
+ in: query
1875
+ description: "Remote name or path whose contents should be removed."
1876
+ schema:
1877
+ type: string
1878
+ required: true
1879
+ Operations_DeletefilePostFsParam:
1880
+ name: fs
1881
+ in: query
1882
+ description: "Remote name or path that contains the file to delete."
1883
+ schema:
1884
+ type: string
1885
+ required: true
1886
+ Operations_DeletefilePostRemoteParam:
1887
+ name: remote
1888
+ in: query
1889
+ description: "Exact path to the file within `fs` that should be deleted."
1890
+ schema:
1891
+ type: string
1892
+ required: true
1893
+ Operations_FsinfoPostFsParam:
1894
+ name: fs
1895
+ in: query
1896
+ description: "Remote name or path to inspect, e.g. `drive:`."
1897
+ schema:
1898
+ type: string
1899
+ required: true
1900
+ Operations_HashsumPostFsParam:
1901
+ name: fs
1902
+ in: query
1903
+ description: "Remote name or path to hash, such as `drive:` or `/`."
1904
+ schema:
1905
+ type: string
1906
+ required: true
1907
+ Operations_HashsumPostHashTypeParam:
1908
+ name: hashType
1909
+ in: query
1910
+ description: "Hash algorithm to use, e.g. `md5`, `sha1`, or another supported name."
1911
+ schema:
1912
+ type: string
1913
+ required: true
1914
+ Operations_HashsumPostDownloadParam:
1915
+ name: download
1916
+ in: query
1917
+ description: "Set to true to force reading the data instead of using remote checksums."
1918
+ schema:
1919
+ type: boolean
1920
+ Operations_HashsumPostBase64Param:
1921
+ name: base64
1922
+ in: query
1923
+ description: "Set to true to emit hash values in base64 rather than hexadecimal."
1924
+ schema:
1925
+ type: boolean
1926
+ Operations_MovefilePostSrcFsParam:
1927
+ name: srcFs
1928
+ in: query
1929
+ description: "Source remote name or path containing the file to move."
1930
+ schema:
1931
+ type: string
1932
+ required: true
1933
+ Operations_MovefilePostSrcRemoteParam:
1934
+ name: srcRemote
1935
+ in: query
1936
+ description: "Path to the source object within `srcFs`."
1937
+ schema:
1938
+ type: string
1939
+ required: true
1940
+ Operations_MovefilePostDstFsParam:
1941
+ name: dstFs
1942
+ in: query
1943
+ description: "Destination remote name or path where the file will be moved."
1944
+ schema:
1945
+ type: string
1946
+ required: true
1947
+ Operations_MovefilePostDstRemoteParam:
1948
+ name: dstRemote
1949
+ in: query
1950
+ description: "Destination path within `dstFs` for the moved object."
1951
+ schema:
1952
+ type: string
1953
+ required: true
1954
+ Operations_PubliclinkPostFsParam:
1955
+ name: fs
1956
+ in: query
1957
+ description: "Remote name or path hosting the object for which to manage a public link."
1958
+ schema:
1959
+ type: string
1960
+ required: true
1961
+ Operations_PubliclinkPostRemoteParam:
1962
+ name: remote
1963
+ in: query
1964
+ description: "Path within `fs` to the object for which to create or remove a public link."
1965
+ schema:
1966
+ type: string
1967
+ required: true
1968
+ Operations_PubliclinkPostUnlinkParam:
1969
+ name: unlink
1970
+ in: query
1971
+ description: "Set to true to remove an existing public link instead of creating one."
1972
+ schema:
1973
+ type: boolean
1974
+ Operations_PubliclinkPostExpireParam:
1975
+ name: expire
1976
+ in: query
1977
+ description: "Optional expiration time for the public link, formatted as supported by the backend."
1978
+ schema:
1979
+ type: string
1980
+ Operations_RmdirsPostFsParam:
1981
+ name: fs
1982
+ in: query
1983
+ description: "Remote name or path to scan for empty directories."
1984
+ schema:
1985
+ type: string
1986
+ required: true
1987
+ Operations_RmdirsPostRemoteParam:
1988
+ name: remote
1989
+ in: query
1990
+ description: "Path within `fs` whose empty subdirectories should be removed."
1991
+ schema:
1992
+ type: string
1993
+ required: true
1994
+ Operations_RmdirsPostLeaveRootParam:
1995
+ name: leaveRoot
1996
+ in: query
1997
+ description: "Set to true to preserve the top-level directory even if empty."
1998
+ schema:
1999
+ type: boolean
2000
+ Operations_SettierPostFsParam:
2001
+ name: fs
2002
+ in: query
2003
+ description: "Remote name or path whose storage class tier should be changed."
2004
+ schema:
2005
+ type: string
2006
+ required: true
2007
+ Operations_SettierfilePostFsParam:
2008
+ name: fs
2009
+ in: query
2010
+ description: "Remote name or path that contains the object whose tier should change."
2011
+ schema:
2012
+ type: string
2013
+ required: true
2014
+ Operations_SettierfilePostRemoteParam:
2015
+ name: remote
2016
+ in: query
2017
+ description: "Path within `fs` to the object whose storage class tier should be updated."
2018
+ schema:
2019
+ type: string
2020
+ required: true
2021
+ Operations_SizePostFsParam:
2022
+ name: fs
2023
+ in: query
2024
+ description: "Remote name or path to measure aggregate size information for."
2025
+ schema:
2026
+ type: string
2027
+ required: true
2028
+ Core_BwlimitPostRateParam:
2029
+ name: rate
2030
+ in: query
2031
+ description: "Bandwidth limit to apply, for example `off`, `5M`, or a schedule string."
2032
+ schema:
2033
+ type: string
2034
+ Core_CommandPostCommandParam:
2035
+ name: command
2036
+ in: query
2037
+ description: "Name of the rclone command to execute, for example `ls` or `lsf`."
2038
+ schema:
2039
+ type: string
2040
+ required: true
2041
+ Core_CommandPostArgParam:
2042
+ name: arg
2043
+ in: query
2044
+ description: "Optional positional arguments for the command. Repeat to supply multiple values."
2045
+ schema:
2046
+ type: array
2047
+ items:
2048
+ type: string
2049
+ style: form
2050
+ explode: true
2051
+ Core_CommandPostOptParam:
2052
+ name: opt
2053
+ in: query
2054
+ description: "Optional command options encoded as a JSON string."
2055
+ schema:
2056
+ type: string
2057
+ Core_CommandPostReturnTypeParam:
2058
+ name: returnType
2059
+ in: query
2060
+ description: "Controls how output is returned; accepts `COMBINED_OUTPUT`, `STREAM`, `STREAM_ONLY_STDOUT`, or `STREAM_ONLY_STDERR`."
2061
+ schema:
2062
+ type: string
2063
+ Core_DuPostDirParam:
2064
+ name: dir
2065
+ in: query
2066
+ description: "Local directory path to report disk usage for. Defaults to the rclone cache directory when omitted."
2067
+ schema:
2068
+ type: string
2069
+ Core_ObscurePostClearParam:
2070
+ name: clear
2071
+ in: query
2072
+ description: "Plain-text string to obscure for storage in the config file."
2073
+ schema:
2074
+ type: string
2075
+ required: true
2076
+ Core_QuitPostExitCodeParam:
2077
+ name: exitCode
2078
+ in: query
2079
+ description: "Optional exit code to use when terminating the rclone process."
2080
+ schema:
2081
+ type: integer
2082
+ Core_StatsDeletePostGroupParam:
2083
+ name: group
2084
+ in: query
2085
+ description: "Stats group identifier to remove."
2086
+ schema:
2087
+ type: string
2088
+ required: true
2089
+ Core_StatsPostGroupParam:
2090
+ name: group
2091
+ in: query
2092
+ description: "Stats group identifier to return a snapshot for. Leave unset to include all groups."
2093
+ schema:
2094
+ type: string
2095
+ Core_StatsPostShortParam:
2096
+ name: short
2097
+ in: query
2098
+ description: "When true, omit the `transferring` and `checking` arrays from the response."
2099
+ schema:
2100
+ type: boolean
2101
+ Core_StatsResetPostGroupParam:
2102
+ name: group
2103
+ in: query
2104
+ description: "Stats group identifier whose counters should be reset. Leave unset to reset all groups."
2105
+ schema:
2106
+ type: string
2107
+ Core_TransferredPostGroupParam:
2108
+ name: group
2109
+ in: query
2110
+ description: "Stats group identifier to filter the completed transfer list. Leave unset for all groups."
2111
+ schema:
2112
+ type: string
2113
+ Debug_SetBlockProfileRatePostRateParam:
2114
+ name: rate
2115
+ in: query
2116
+ description: "Sampling interval in nanoseconds for blocking profile collection; use 1 to capture all events."
2117
+ schema:
2118
+ type: integer
2119
+ required: true
2120
+ Debug_SetGcPercentPostGcPercentParam:
2121
+ name: gc-percent
2122
+ in: query
2123
+ description: "Target percentage of newly allocated data to trigger garbage collection."
2124
+ schema:
2125
+ type: integer
2126
+ required: true
2127
+ Debug_SetMutexProfileFractionPostRateParam:
2128
+ name: rate
2129
+ in: query
2130
+ description: "Sampling fraction for mutex contention profiling; set to 0 to disable."
2131
+ schema:
2132
+ type: integer
2133
+ required: true
2134
+ Debug_SetSoftMemoryLimitPostMemLimitParam:
2135
+ name: mem-limit
2136
+ in: query
2137
+ description: "Soft memory limit for the Go runtime in bytes."
2138
+ schema:
2139
+ type: integer
2140
+ required: true
2141
+ Mount_MountPostFsParam:
2142
+ name: fs
2143
+ in: query
2144
+ description: "Remote path to mount, such as `drive:` or `remote:subdir`."
2145
+ schema:
2146
+ type: string
2147
+ required: true
2148
+ Mount_MountPostMountPointParam:
2149
+ name: mountPoint
2150
+ in: query
2151
+ description: "Absolute local path where the remote should be mounted."
2152
+ schema:
2153
+ type: string
2154
+ required: true
2155
+ Mount_MountPostMountTypeParam:
2156
+ name: mountType
2157
+ in: query
2158
+ description: "Optional mount implementation to use (`mount`, `cmount`, or `mount2`)."
2159
+ schema:
2160
+ type: string
2161
+ Mount_MountPostMountOptParam:
2162
+ name: mountOpt
2163
+ in: query
2164
+ description: "Mount options encoded as JSON, matching flags accepted by `rclone mount`."
2165
+ schema:
2166
+ type: string
2167
+ Mount_MountPostVfsOptParam:
2168
+ name: vfsOpt
2169
+ in: query
2170
+ description: "VFS options encoded as JSON, matching flags accepted by `rclone mount`."
2171
+ schema:
2172
+ type: string
2173
+ Mount_UnmountPostMountPointParam:
2174
+ name: mountPoint
2175
+ in: query
2176
+ description: "Local mount point path to unmount."
2177
+ schema:
2178
+ type: string
2179
+ required: true
2180
+ Rc_NoopauthPostAdditionalParam:
2181
+ name: params
2182
+ in: query
2183
+ description: Additional arbitrary parameters allowed.
2184
+ schema:
2185
+ type: object
2186
+ style: form
2187
+ explode: true
2188
+ Rc_ErrorPostAdditionalParam:
2189
+ name: params
2190
+ in: query
2191
+ description: Additional arbitrary parameters allowed.
2192
+ schema:
2193
+ type: object
2194
+ style: form
2195
+ explode: true
2196
+ Backend_CommandPostCommandParam:
2197
+ name: command
2198
+ in: query
2199
+ description: "Backend-specific command to invoke."
2200
+ schema:
2201
+ type: string
2202
+ required: true
2203
+ Backend_CommandPostFsParam:
2204
+ name: fs
2205
+ in: query
2206
+ description: "Remote name or path the backend command should target."
2207
+ schema:
2208
+ type: string
2209
+ Backend_CommandPostArgParam:
2210
+ name: arg
2211
+ in: query
2212
+ description: "Optional positional arguments for the backend command."
2213
+ schema:
2214
+ type: array
2215
+ items:
2216
+ type: string
2217
+ style: form
2218
+ explode: true
2219
+ Backend_CommandPostOptParam:
2220
+ name: opt
2221
+ in: query
2222
+ description: "Backend command options encoded as a JSON string."
2223
+ schema:
2224
+ type: string
2225
+ Cache_ExpirePostRemoteParam:
2226
+ name: remote
2227
+ in: query
2228
+ description: "Remote path to expire from the cache, e.g. `remote:path/to/dir`."
2229
+ schema:
2230
+ type: string
2231
+ required: true
2232
+ Cache_ExpirePostWithDataParam:
2233
+ name: withData
2234
+ in: query
2235
+ description: "Set to true to drop cached chunk data along with directory entries."
2236
+ schema:
2237
+ type: boolean
2238
+ Cache_FetchPostChunksParam:
2239
+ name: chunks
2240
+ in: query
2241
+ description: "Comma-separated chunk specifier list (e.g. `0:10,25:30`) describing file pieces to prefetch."
2242
+ schema:
2243
+ type: string
2244
+ Cache_FetchPostAdditionalParam:
2245
+ name: params
2246
+ in: query
2247
+ description: Additional arbitrary parameters allowed.
2248
+ schema:
2249
+ type: object
2250
+ style: form
2251
+ explode: true
2252
+ Config_CreatePostNameParam:
2253
+ name: name
2254
+ in: query
2255
+ description: "Name of the new remote configuration."
2256
+ schema:
2257
+ type: string
2258
+ required: true
2259
+ Config_CreatePostParametersParam:
2260
+ name: parameters
2261
+ in: query
2262
+ description: "JSON object of configuration key/value pairs required for the remote."
2263
+ schema:
2264
+ type: string
2265
+ required: true
2266
+ Config_CreatePostTypeParam:
2267
+ name: type
2268
+ in: query
2269
+ description: "Backend type identifier, such as `drive`, `s3`, or `dropbox`."
2270
+ schema:
2271
+ type: string
2272
+ required: true
2273
+ Config_CreatePostOptParam:
2274
+ name: opt
2275
+ in: query
2276
+ description: "Optional JSON object controlling interactive behaviour (e.g. `obscure`, `continue`)."
2277
+ schema:
2278
+ type: string
2279
+ Config_DeletePostNameParam:
2280
+ name: name
2281
+ in: query
2282
+ description: "Name of the remote configuration to delete."
2283
+ schema:
2284
+ type: string
2285
+ required: true
2286
+ Config_GetPostNameParam:
2287
+ name: name
2288
+ in: query
2289
+ description: "Name of the remote configuration to fetch."
2290
+ schema:
2291
+ type: string
2292
+ required: true
2293
+ Config_PasswordPostNameParam:
2294
+ name: name
2295
+ in: query
2296
+ description: "Name of the remote whose secrets should be updated."
2297
+ schema:
2298
+ type: string
2299
+ required: true
2300
+ Config_PasswordPostParametersParam:
2301
+ name: parameters
2302
+ in: query
2303
+ description: "JSON object of password answers, typically including `pass`."
2304
+ schema:
2305
+ type: string
2306
+ required: true
2307
+ Config_SetpathPostPathParam:
2308
+ name: path
2309
+ in: query
2310
+ description: "Absolute path to the `rclone.conf` file that rclone should use."
2311
+ schema:
2312
+ type: string
2313
+ required: true
2314
+ Config_UnlockPostConfigPasswordParam:
2315
+ name: config_password
2316
+ in: query
2317
+ description: "Password used to unlock an encrypted config file."
2318
+ schema:
2319
+ type: string
2320
+ required: true
2321
+ Config_UpdatePostNameParam:
2322
+ name: name
2323
+ in: query
2324
+ description: "Name of the remote configuration to update."
2325
+ schema:
2326
+ type: string
2327
+ required: true
2328
+ Config_UpdatePostParametersParam:
2329
+ name: parameters
2330
+ in: query
2331
+ description: "JSON object of configuration key/value pairs to apply to the remote."
2332
+ schema:
2333
+ type: string
2334
+ required: true
2335
+ Config_UpdatePostOptParam:
2336
+ name: opt
2337
+ in: query
2338
+ description: "Optional JSON object controlling update behaviour (e.g. `obscure`, `continue`)."
2339
+ schema:
2340
+ type: string
2341
+ Job_StatusPostJobidParam:
2342
+ name: jobid
2343
+ in: query
2344
+ description: "Numeric identifier of the job to query, as returned from an async call."
2345
+ schema:
2346
+ type: number
2347
+ required: true
2348
+ Job_StopPostJobidParam:
2349
+ name: jobid
2350
+ in: query
2351
+ description: "Numeric identifier of the job to cancel."
2352
+ schema:
2353
+ type: number
2354
+ required: true
2355
+ Job_StopgroupPostGroupParam:
2356
+ name: group
2357
+ in: query
2358
+ description: "Stats group name whose active jobs should be stopped."
2359
+ schema:
2360
+ type: string
2361
+ required: true
2362
+ Operations_ListPostFsParam:
2363
+ name: fs
2364
+ in: query
2365
+ description: "Remote name or path to list, for example `drive:`."
2366
+ schema:
2367
+ type: string
2368
+ required: true
2369
+ Operations_ListPostRemoteParam:
2370
+ name: remote
2371
+ in: query
2372
+ description: "Directory path within `fs` to list; leave empty to target the root."
2373
+ schema:
2374
+ type: string
2375
+ required: true
2376
+ Operations_ListPostOptParam:
2377
+ name: opt
2378
+ in: query
2379
+ schema:
2380
+ type: string
2381
+ description: "Optional JSON-encoded object of listing flags (e.g. `{ \"recurse\": true, \"showHash\": true }`)."
2382
+ Operations_ListPostRecurseParam:
2383
+ name: recurse
2384
+ in: query
2385
+ description: "Set to true to list directories recursively."
2386
+ schema:
2387
+ type: boolean
2388
+ Operations_ListPostNoModTimeParam:
2389
+ name: noModTime
2390
+ in: query
2391
+ description: "Set to true to omit modification times for faster listings on some backends."
2392
+ schema:
2393
+ type: boolean
2394
+ Operations_ListPostShowEncryptedParam:
2395
+ name: showEncrypted
2396
+ in: query
2397
+ description: "Set to true to include encrypted names when using crypt remotes."
2398
+ schema:
2399
+ type: boolean
2400
+ Operations_ListPostShowOrigIDsParam:
2401
+ name: showOrigIDs
2402
+ in: query
2403
+ description: "Set to true to include original backend identifiers where available."
2404
+ schema:
2405
+ type: boolean
2406
+ Operations_ListPostShowHashParam:
2407
+ name: showHash
2408
+ in: query
2409
+ description: "Set to true to include hash digests for each entry."
2410
+ schema:
2411
+ type: boolean
2412
+ Operations_ListPostNoMimeTypeParam:
2413
+ name: noMimeType
2414
+ in: query
2415
+ description: "Set to true to omit MIME type detection."
2416
+ schema:
2417
+ type: boolean
2418
+ Operations_ListPostDirsOnlyParam:
2419
+ name: dirsOnly
2420
+ in: query
2421
+ description: "Set to true to return only directory entries."
2422
+ schema:
2423
+ type: boolean
2424
+ Operations_ListPostFilesOnlyParam:
2425
+ name: filesOnly
2426
+ in: query
2427
+ description: "Set to true to return only file entries."
2428
+ schema:
2429
+ type: boolean
2430
+ Operations_ListPostMetadataParam:
2431
+ name: metadata
2432
+ in: query
2433
+ description: "Set to true to include backend-provided metadata maps."
2434
+ schema:
2435
+ type: boolean
2436
+ Operations_ListPostHashTypesParam:
2437
+ name: hashTypes
2438
+ in: query
2439
+ description: "Specify one or more hash algorithms to include when `showHash` is true (e.g. `md5`)."
2440
+ schema:
2441
+ type: array
2442
+ items:
2443
+ type: string
2444
+ style: form
2445
+ explode: true
2446
+ Operations_StatPostFsParam:
2447
+ name: fs
2448
+ in: query
2449
+ description: "Remote name or path that contains the item to inspect."
2450
+ schema:
2451
+ type: string
2452
+ required: true
2453
+ Operations_StatPostRemoteParam:
2454
+ name: remote
2455
+ in: query
2456
+ description: "Path to the file or directory within `fs` to describe."
2457
+ schema:
2458
+ type: string
2459
+ required: true
2460
+ Operations_StatPostOptParam:
2461
+ name: opt
2462
+ in: query
2463
+ schema:
2464
+ type: string
2465
+ description: "Optional JSON object of listing flags, matching those accepted by `operations/list`."
2466
+ Operations_AboutPostFsParam:
2467
+ name: fs
2468
+ in: query
2469
+ description: "Remote name or path to query for capacity information."
2470
+ schema:
2471
+ type: string
2472
+ required: true
2473
+ Operations_PurgePostFsParam:
2474
+ name: fs
2475
+ in: query
2476
+ description: "Remote name or path from which to remove all contents."
2477
+ schema:
2478
+ type: string
2479
+ required: true
2480
+ Operations_PurgePostRemoteParam:
2481
+ name: remote
2482
+ in: query
2483
+ description: "Path within `fs` whose contents should be purged."
2484
+ schema:
2485
+ type: string
2486
+ required: true
2487
+ Operations_UploadfilePostFsParam:
2488
+ name: fs
2489
+ in: query
2490
+ description: "Remote name or path where the uploaded file should be stored."
2491
+ schema:
2492
+ type: string
2493
+ required: true
2494
+ Operations_UploadfilePostRemoteParam:
2495
+ name: remote
2496
+ in: query
2497
+ description: "Destination path within `fs` for the uploaded file."
2498
+ schema:
2499
+ type: string
2500
+ required: true
2501
+ Operations_MkdirPostFsParam:
2502
+ name: fs
2503
+ in: query
2504
+ description: "Remote name or path in which to create a directory."
2505
+ schema:
2506
+ type: string
2507
+ required: true
2508
+ Operations_MkdirPostRemoteParam:
2509
+ name: remote
2510
+ in: query
2511
+ description: "Directory path within `fs` to create."
2512
+ schema:
2513
+ type: string
2514
+ required: true
2515
+ Operations_RmdirPostFsParam:
2516
+ name: fs
2517
+ in: query
2518
+ description: "Remote name or path containing the directory to remove."
2519
+ schema:
2520
+ type: string
2521
+ required: true
2522
+ Operations_RmdirPostRemoteParam:
2523
+ name: remote
2524
+ in: query
2525
+ description: "Directory path within `fs` to delete."
2526
+ schema:
2527
+ type: string
2528
+ required: true
2529
+ Operations_CheckPostSrcFsParam:
2530
+ name: srcFs
2531
+ in: query
2532
+ description: "Source remote name or path to verify, e.g. `drive:`."
2533
+ schema:
2534
+ type: string
2535
+ required: true
2536
+ Operations_CheckPostDstFsParam:
2537
+ name: dstFs
2538
+ in: query
2539
+ description: "Destination remote name or path that should match the source."
2540
+ schema:
2541
+ type: string
2542
+ required: true
2543
+ Operations_CheckPostDownloadParam:
2544
+ name: download
2545
+ in: query
2546
+ description: "Set to true to read file contents during comparison instead of relying on hashes."
2547
+ schema:
2548
+ type: boolean
2549
+ Operations_CheckPostCheckFileHashParam:
2550
+ name: checkFileHash
2551
+ in: query
2552
+ description: "Hash name to expect in the supplied SUM file, such as `md5`."
2553
+ schema:
2554
+ type: string
2555
+ Operations_CheckPostCheckFileFsParam:
2556
+ name: checkFileFs
2557
+ in: query
2558
+ description: "Remote containing the checksum SUM file when using `checkFileHash`."
2559
+ schema:
2560
+ type: string
2561
+ Operations_CheckPostCheckFileRemoteParam:
2562
+ name: checkFileRemote
2563
+ in: query
2564
+ description: "Path within `checkFileFs` to the checksum SUM file."
2565
+ schema:
2566
+ type: string
2567
+ Operations_CheckPostOneWayParam:
2568
+ name: oneWay
2569
+ in: query
2570
+ description: "Set to true to only ensure that source files exist on the destination."
2571
+ schema:
2572
+ type: boolean
2573
+ Operations_CheckPostCombinedParam:
2574
+ name: combined
2575
+ in: query
2576
+ description: "Set to true to include a combined summary report in the response."
2577
+ schema:
2578
+ type: boolean
2579
+ Operations_CheckPostMissingOnSrcParam:
2580
+ name: missingOnSrc
2581
+ in: query
2582
+ description: "Set to true to report files missing from the source."
2583
+ schema:
2584
+ type: boolean
2585
+ Operations_CheckPostMissingOnDstParam:
2586
+ name: missingOnDst
2587
+ in: query
2588
+ description: "Set to true to report files missing from the destination."
2589
+ schema:
2590
+ type: boolean
2591
+ Operations_CheckPostMatchParam:
2592
+ name: match
2593
+ in: query
2594
+ description: "Set to true to include matching files in the report."
2595
+ schema:
2596
+ type: boolean
2597
+ Operations_CheckPostDifferParam:
2598
+ name: differ
2599
+ in: query
2600
+ description: "Set to true to include differing files in the report."
2601
+ schema:
2602
+ type: boolean
2603
+ Operations_CheckPostErrorParam:
2604
+ name: error
2605
+ in: query
2606
+ description: "Set to true to include entries that encountered errors."
2607
+ schema:
2608
+ type: boolean
2609
+ Sync_SyncPostSrcFsParam:
2610
+ name: srcFs
2611
+ in: query
2612
+ description: "Source remote path to sync from, e.g. `drive:src`."
2613
+ schema:
2614
+ type: string
2615
+ required: true
2616
+ Sync_SyncPostDstFsParam:
2617
+ name: dstFs
2618
+ in: query
2619
+ description: "Destination remote path to sync to, e.g. `drive:dst`."
2620
+ schema:
2621
+ type: string
2622
+ required: true
2623
+ Sync_SyncPostCreateEmptySrcDirsParam:
2624
+ name: createEmptySrcDirs
2625
+ in: query
2626
+ description: "Set to true to create empty source directories on the destination."
2627
+ schema:
2628
+ type: boolean
2629
+ Sync_CopyPostSrcFsParam:
2630
+ name: srcFs
2631
+ in: query
2632
+ description: "Source remote path to copy from."
2633
+ schema:
2634
+ type: string
2635
+ required: true
2636
+ Sync_CopyPostDstFsParam:
2637
+ name: dstFs
2638
+ in: query
2639
+ description: "Destination remote path to copy to."
2640
+ schema:
2641
+ type: string
2642
+ required: true
2643
+ Sync_CopyPostCreateEmptySrcDirsParam:
2644
+ name: createEmptySrcDirs
2645
+ in: query
2646
+ description: "Set to true to replicate empty source directories on the destination."
2647
+ schema:
2648
+ type: boolean
2649
+ Sync_MovePostSrcFsParam:
2650
+ name: srcFs
2651
+ in: query
2652
+ description: "Source remote path whose contents will be moved."
2653
+ schema:
2654
+ type: string
2655
+ required: true
2656
+ Sync_MovePostDstFsParam:
2657
+ name: dstFs
2658
+ in: query
2659
+ description: "Destination remote path that will receive moved files."
2660
+ schema:
2661
+ type: string
2662
+ required: true
2663
+ Sync_MovePostCreateEmptySrcDirsParam:
2664
+ name: createEmptySrcDirs
2665
+ in: query
2666
+ description: "Set to true to create empty source directories on the destination."
2667
+ schema:
2668
+ type: boolean
2669
+ Sync_MovePostDeleteEmptySrcDirsParam:
2670
+ name: deleteEmptySrcDirs
2671
+ in: query
2672
+ description: "Set to true to delete empty directories from the source after the move completes."
2673
+ schema:
2674
+ type: boolean
2675
+ Sync_BisyncPostPath1Param:
2676
+ name: path1
2677
+ in: query
2678
+ description: "First remote directory, e.g. `drive:path1`."
2679
+ schema:
2680
+ type: string
2681
+ required: true
2682
+ Sync_BisyncPostPath2Param:
2683
+ name: path2
2684
+ in: query
2685
+ description: "Second remote directory, e.g. `drive:path2`."
2686
+ schema:
2687
+ type: string
2688
+ required: true
2689
+ Sync_BisyncPostDryRunParam:
2690
+ name: dryRun
2691
+ in: query
2692
+ description: "Set to true to simulate the bisync run without making changes."
2693
+ schema:
2694
+ type: boolean
2695
+ Sync_BisyncPostResyncParam:
2696
+ name: resync
2697
+ in: query
2698
+ description: "Set to true to perform a one-time resync, rebuilding bisync history."
2699
+ schema:
2700
+ type: boolean
2701
+ Sync_BisyncPostCheckAccessParam:
2702
+ name: checkAccess
2703
+ in: query
2704
+ description: "Set to true to abort if `RCLONE_TEST` files are missing on either side."
2705
+ schema:
2706
+ type: boolean
2707
+ Sync_BisyncPostCheckFilenameParam:
2708
+ name: checkFilename
2709
+ in: query
2710
+ description: "Override the access-check sentinel filename; defaults to `RCLONE_TEST`."
2711
+ schema:
2712
+ type: string
2713
+ Sync_BisyncPostMaxDeleteParam:
2714
+ name: maxDelete
2715
+ in: query
2716
+ description: "Abort the run if deletions exceed this percentage (default 50)."
2717
+ schema:
2718
+ type: number
2719
+ Sync_BisyncPostForceParam:
2720
+ name: force
2721
+ in: query
2722
+ description: "Set to true to bypass the `maxDelete` safety check."
2723
+ schema:
2724
+ type: boolean
2725
+ Sync_BisyncPostCheckSyncParam:
2726
+ name: checkSync
2727
+ in: query
2728
+ description: "Controls final listing comparison; leave true for normal verification or set false to skip."
2729
+ schema:
2730
+ type: boolean
2731
+ Sync_BisyncPostCreateEmptySrcDirsParam:
2732
+ name: createEmptySrcDirs
2733
+ in: query
2734
+ description: "Set to true to mirror empty directories between the two paths."
2735
+ schema:
2736
+ type: boolean
2737
+ Sync_BisyncPostRemoveEmptyDirsParam:
2738
+ name: removeEmptyDirs
2739
+ in: query
2740
+ description: "Set to true to remove empty directories during cleanup."
2741
+ schema:
2742
+ type: boolean
2743
+ Sync_BisyncPostFiltersFileParam:
2744
+ name: filtersFile
2745
+ in: query
2746
+ description: "Path to an rclone filters file applied to both paths."
2747
+ schema:
2748
+ type: string
2749
+ Sync_BisyncPostIgnoreListingChecksumParam:
2750
+ name: ignoreListingChecksum
2751
+ in: query
2752
+ description: "Set to true to ignore checksum differences when comparing listings."
2753
+ schema:
2754
+ type: boolean
2755
+ Sync_BisyncPostResilientParam:
2756
+ name: resilient
2757
+ in: query
2758
+ description: "Set to true to allow retrying after certain recoverable errors."
2759
+ schema:
2760
+ type: boolean
2761
+ Sync_BisyncPostWorkdirParam:
2762
+ name: workdir
2763
+ in: query
2764
+ description: "Directory path used to store bisync working files."
2765
+ schema:
2766
+ type: string
2767
+ Sync_BisyncPostBackupdir1Param:
2768
+ name: backupdir1
2769
+ in: query
2770
+ description: "Backup directory on the first remote for changed files."
2771
+ schema:
2772
+ type: string
2773
+ Sync_BisyncPostBackupdir2Param:
2774
+ name: backupdir2
2775
+ in: query
2776
+ description: "Backup directory on the second remote for changed files."
2777
+ schema:
2778
+ type: string
2779
+ Sync_BisyncPostNoCleanupParam:
2780
+ name: noCleanup
2781
+ in: query
2782
+ description: "Set to true to keep bisync working files after completion."
2783
+ schema:
2784
+ type: boolean
2785
+ Options_GetPostBlocksParam:
2786
+ name: blocks
2787
+ in: query
2788
+ description: "Optional comma-separated list of option block names to return."
2789
+ schema:
2790
+ type: string
2791
+ Options_InfoPostBlocksParam:
2792
+ name: blocks
2793
+ in: query
2794
+ description: "Optional comma-separated list of option block names to describe."
2795
+ schema:
2796
+ type: string
2797
+ Options_SetPostDlnaParam:
2798
+ name: dlna
2799
+ in: query
2800
+ description: "Overrides for the `dlna` option block."
2801
+ style: deepObject
2802
+ explode: true
2803
+ schema: &OptionsSetBlockSchema
2804
+ type: object
2805
+ additionalProperties:
2806
+ oneOf:
2807
+ - type: string
2808
+ - type: number
2809
+ - type: integer
2810
+ - type: boolean
2811
+ - type: array
2812
+ items: {}
2813
+ - type: object
2814
+ additionalProperties: {}
2815
+ Options_SetPostFilterParam:
2816
+ name: filter
2817
+ in: query
2818
+ description: "Overrides for the `filter` option block."
2819
+ style: deepObject
2820
+ explode: true
2821
+ schema: *OptionsSetBlockSchema
2822
+ Options_SetPostFtpParam:
2823
+ name: ftp
2824
+ in: query
2825
+ description: "Overrides for the `ftp` option block."
2826
+ style: deepObject
2827
+ explode: true
2828
+ schema: *OptionsSetBlockSchema
2829
+ Options_SetPostMainParam:
2830
+ name: main
2831
+ in: query
2832
+ description: "Overrides for the `main` option block."
2833
+ style: deepObject
2834
+ explode: true
2835
+ schema: *OptionsSetBlockSchema
2836
+ Options_SetPostHttpParam:
2837
+ name: http
2838
+ in: query
2839
+ description: "Overrides for the `http` option block."
2840
+ style: deepObject
2841
+ explode: true
2842
+ schema: *OptionsSetBlockSchema
2843
+ Options_SetPostLogParam:
2844
+ name: log
2845
+ in: query
2846
+ description: "Overrides for the `log` option block."
2847
+ style: deepObject
2848
+ explode: true
2849
+ schema: *OptionsSetBlockSchema
2850
+ Options_SetPostMountParam:
2851
+ name: mount
2852
+ in: query
2853
+ description: "Overrides for the `mount` option block."
2854
+ style: deepObject
2855
+ explode: true
2856
+ schema: *OptionsSetBlockSchema
2857
+ Options_SetPostNfsParam:
2858
+ name: nfs
2859
+ in: query
2860
+ description: "Overrides for the `nfs` option block."
2861
+ style: deepObject
2862
+ explode: true
2863
+ schema: *OptionsSetBlockSchema
2864
+ Options_SetPostProxyParam:
2865
+ name: proxy
2866
+ in: query
2867
+ description: "Overrides for the `proxy` option block."
2868
+ style: deepObject
2869
+ explode: true
2870
+ schema: *OptionsSetBlockSchema
2871
+ Options_SetPostRcParam:
2872
+ name: rc
2873
+ in: query
2874
+ description: "Overrides for the `rc` option block."
2875
+ style: deepObject
2876
+ explode: true
2877
+ schema: *OptionsSetBlockSchema
2878
+ Options_SetPostResticParam:
2879
+ name: restic
2880
+ in: query
2881
+ description: "Overrides for the `restic` option block."
2882
+ style: deepObject
2883
+ explode: true
2884
+ schema: *OptionsSetBlockSchema
2885
+ Options_SetPostS3Param:
2886
+ name: s3
2887
+ in: query
2888
+ description: "Overrides for the `s3` option block."
2889
+ style: deepObject
2890
+ explode: true
2891
+ schema: *OptionsSetBlockSchema
2892
+ Options_SetPostSftpParam:
2893
+ name: sftp
2894
+ in: query
2895
+ description: "Overrides for the `sftp` option block."
2896
+ style: deepObject
2897
+ explode: true
2898
+ schema: *OptionsSetBlockSchema
2899
+ Options_SetPostVfsParam:
2900
+ name: vfs
2901
+ in: query
2902
+ description: "Overrides for the `vfs` option block."
2903
+ style: deepObject
2904
+ explode: true
2905
+ schema: *OptionsSetBlockSchema
2906
+ Options_SetPostWebdavParam:
2907
+ name: webdav
2908
+ in: query
2909
+ description: "Overrides for the `webdav` option block."
2910
+ style: deepObject
2911
+ explode: true
2912
+ schema: *OptionsSetBlockSchema
2913
+ Serve_StartPostTypeParam:
2914
+ name: type
2915
+ in: query
2916
+ description: "Type of server to start (e.g. `http`, `webdav`, `ftp`, `sftp`)."
2917
+ schema:
2918
+ type: string
2919
+ required: true
2920
+ Serve_StartPostFsParam:
2921
+ name: fs
2922
+ in: query
2923
+ description: "Remote path that will be served."
2924
+ schema:
2925
+ type: string
2926
+ required: true
2927
+ Serve_StartPostAddrParam:
2928
+ name: addr
2929
+ in: query
2930
+ description: "Address and port to bind the server to, such as `:5572` or `localhost:8080`."
2931
+ schema:
2932
+ type: string
2933
+ required: true
2934
+ Serve_StartPostAdditionalParam:
2935
+ name: params
2936
+ in: query
2937
+ description: Additional arbitrary parameters allowed.
2938
+ schema:
2939
+ type: object
2940
+ style: form
2941
+ explode: true
2942
+ Serve_StopPostIdParam:
2943
+ name: id
2944
+ in: query
2945
+ description: "Identifier of the running serve instance returned by `serve/start`."
2946
+ schema:
2947
+ type: string
2948
+ required: true
2949
+ Vfs_ForgetPostFsParam:
2950
+ name: fs
2951
+ in: query
2952
+ description: "Optional VFS identifier to target; required when more than one VFS is active."
2953
+ schema:
2954
+ type: string
2955
+ Vfs_ForgetPostAdditionalParam:
2956
+ name: params
2957
+ in: query
2958
+ description: Additional arbitrary parameters allowed.
2959
+ schema:
2960
+ type: object
2961
+ style: form
2962
+ explode: true
2963
+ Vfs_ListPostFsParam:
2964
+ name: fs
2965
+ in: query
2966
+ description: "Optional VFS identifier; omit to list all active VFS instances."
2967
+ schema:
2968
+ type: string
2969
+ Vfs_PollIntervalPostFsParam:
2970
+ name: fs
2971
+ in: query
2972
+ description: "Optional VFS identifier whose poll interval should be queried or modified."
2973
+ schema:
2974
+ type: string
2975
+ Vfs_PollIntervalPostIntervalParam:
2976
+ name: interval
2977
+ in: query
2978
+ description: "Duration string (e.g. `5m`) to set as the new poll interval."
2979
+ schema:
2980
+ type: string
2981
+ Vfs_PollIntervalPostTimeoutParam:
2982
+ name: timeout
2983
+ in: query
2984
+ description: "Duration to wait for the poll interval change to take effect; `0` waits indefinitely."
2985
+ schema:
2986
+ type: string
2987
+ Vfs_QueuePostFsParam:
2988
+ name: fs
2989
+ in: query
2990
+ description: "Optional VFS identifier whose upload queue should be inspected."
2991
+ schema:
2992
+ type: string
2993
+ Vfs_QueueSetExpiryPostFsParam:
2994
+ name: fs
2995
+ in: query
2996
+ description: "Optional VFS identifier for the queued item."
2997
+ schema:
2998
+ type: string
2999
+ Vfs_QueueSetExpiryPostIdParam:
3000
+ name: id
3001
+ in: query
3002
+ description: "Queue item ID as returned by `vfs/queue`."
3003
+ schema:
3004
+ type: integer
3005
+ required: true
3006
+ Vfs_QueueSetExpiryPostExpiryParam:
3007
+ name: expiry
3008
+ in: query
3009
+ description: "New eligibility time in seconds (may be negative for immediate upload)."
3010
+ schema:
3011
+ type: number
3012
+ required: true
3013
+ Vfs_QueueSetExpiryPostRelativeParam:
3014
+ name: relative
3015
+ in: query
3016
+ description: "Set to true to treat `expiry` as relative to the current value."
3017
+ schema:
3018
+ type: boolean
3019
+ Vfs_RefreshPostFsParam:
3020
+ name: fs
3021
+ in: query
3022
+ description: "Optional VFS identifier whose directory cache should be refreshed."
3023
+ schema:
3024
+ type: string
3025
+ Vfs_RefreshPostRecursiveParam:
3026
+ name: recursive
3027
+ in: query
3028
+ description: "Set to true to refresh entire directory trees."
3029
+ schema:
3030
+ type: boolean
3031
+ Vfs_RefreshPostAdditionalParam:
3032
+ name: params
3033
+ in: query
3034
+ description: Additional arbitrary parameters allowed.
3035
+ schema:
3036
+ type: object
3037
+ style: form
3038
+ explode: true
3039
+ Vfs_StatsPostFsParam:
3040
+ name: fs
3041
+ in: query
3042
+ description: "Optional VFS identifier whose statistics should be returned."
3043
+ schema:
3044
+ type: string
3045
+ Pluginsctl_AddPluginPostUrlParam:
3046
+ name: url
3047
+ in: query
3048
+ description: "Repository URL of the plugin to install."
3049
+ schema:
3050
+ type: string
3051
+ required: true
3052
+ Pluginsctl_GetPluginsForTypePostTypeParam:
3053
+ name: type
3054
+ in: query
3055
+ description: "MIME type to match when listing plugins."
3056
+ schema:
3057
+ type: string
3058
+ Pluginsctl_GetPluginsForTypePostPluginTypeParam:
3059
+ name: pluginType
3060
+ in: query
3061
+ description: "Filter results by plugin type (e.g. `test`)."
3062
+ schema:
3063
+ type: string
3064
+ Pluginsctl_RemovePluginPostNameParam:
3065
+ name: name
3066
+ in: query
3067
+ description: "Name of the plugin to uninstall."
3068
+ schema:
3069
+ type: string
3070
+ required: true
3071
+ Pluginsctl_RemoveTestPluginPostNameParam:
3072
+ name: name
3073
+ in: query
3074
+ description: "Name of the test plugin to uninstall."
3075
+ schema:
3076
+ type: string
3077
+ required: true
3078
+ responses:
3079
+ RcError:
3080
+ description: Any error response (HTTP 4xx/5xx)
3081
+ content:
3082
+ application/json:
3083
+ schema:
3084
+ $ref: "#/components/schemas/RcError"
3085
+ EmptyResponse:
3086
+ description: "Request succeeded with no response body."
3087
+ EmptyObjectResponse:
3088
+ description: "Request succeeded returning an empty JSON object."
3089
+ content:
3090
+ application/json:
3091
+ schema:
3092
+ type: object
3093
+ properties: {}
3094
+ RcNoopResponse:
3095
+ description: "Echoes any supplied parameters, useful for testing RC connectivity."
3096
+ content:
3097
+ application/json:
3098
+ schema:
3099
+ type: object
3100
+ additionalProperties:
3101
+ nullable: true
3102
+ OperationsFsinfoResponse:
3103
+ description: "Capabilities, supported hashes, and metadata for the specified remote."
3104
+ content:
3105
+ application/json:
3106
+ schema:
3107
+ type: object
3108
+ properties:
3109
+ Features:
3110
+ type: object
3111
+ additionalProperties:
3112
+ type: boolean
3113
+ Hashes:
3114
+ type: array
3115
+ items:
3116
+ type: string
3117
+ MetadataInfo:
3118
+ type: object
3119
+ nullable: true
3120
+ additionalProperties: true
3121
+ Name:
3122
+ type: string
3123
+ Precision:
3124
+ type: number
3125
+ Root:
3126
+ type: string
3127
+ String:
3128
+ type: string
3129
+ required:
3130
+ - Features
3131
+ - Hashes
3132
+ - Name
3133
+ - Precision
3134
+ - Root
3135
+ - String
3136
+ OperationsHashsumResponse:
3137
+ description: "Hash algorithm used and the ordered hash lines emitted by `operations/hashsum`."
3138
+ content:
3139
+ application/json:
3140
+ schema:
3141
+ type: object
3142
+ properties:
3143
+ hashType:
3144
+ type: string
3145
+ hashsum:
3146
+ type: array
3147
+ items:
3148
+ type: string
3149
+ required:
3150
+ - hashType
3151
+ - hashsum
3152
+ OperationsPubliclinkResponse:
3153
+ description: "Public sharing URL returned by `operations/publiclink`."
3154
+ content:
3155
+ application/json:
3156
+ schema:
3157
+ type: object
3158
+ properties:
3159
+ url:
3160
+ type: string
3161
+ format: uri
3162
+ required:
3163
+ - url
3164
+ OperationsSizeResponse:
3165
+ description: "Aggregate object counts and total size from `operations/size`."
3166
+ content:
3167
+ application/json:
3168
+ schema:
3169
+ type: object
3170
+ properties:
3171
+ bytes:
3172
+ type: number
3173
+ count:
3174
+ type: integer
3175
+ sizeless:
3176
+ type: integer
3177
+ required:
3178
+ - bytes
3179
+ - count
3180
+ - sizeless
3181
+ CoreBwlimitResponse:
3182
+ description: "Effective bandwidth limits in bytes per second and human readable form."
3183
+ content:
3184
+ application/json:
3185
+ schema:
3186
+ type: object
3187
+ properties:
3188
+ bytesPerSecond:
3189
+ type: integer
3190
+ bytesPerSecondRx:
3191
+ type: integer
3192
+ bytesPerSecondTx:
3193
+ type: integer
3194
+ rate:
3195
+ type: string
3196
+ required:
3197
+ - bytesPerSecond
3198
+ - bytesPerSecondRx
3199
+ - bytesPerSecondTx
3200
+ - rate
3201
+ CoreCommandResponse:
3202
+ description: "Outcome of a command executed with `core/command`, including streamed result."
3203
+ content:
3204
+ application/json:
3205
+ schema:
3206
+ type: object
3207
+ properties:
3208
+ error:
3209
+ type: boolean
3210
+ result:
3211
+ type: string
3212
+ nullable: true
3213
+ returnType:
3214
+ type: string
3215
+ nullable: true
3216
+ required:
3217
+ - error
3218
+ CoreDuResponse:
3219
+ description: "Disk usage summary for the requested directory."
3220
+ content:
3221
+ application/json:
3222
+ schema:
3223
+ type: object
3224
+ properties:
3225
+ dir:
3226
+ type: string
3227
+ info:
3228
+ type: object
3229
+ properties:
3230
+ Free:
3231
+ type: integer
3232
+ Available:
3233
+ type: integer
3234
+ Total:
3235
+ type: integer
3236
+ required:
3237
+ - Free
3238
+ - Available
3239
+ - Total
3240
+ required:
3241
+ - dir
3242
+ - info
3243
+ CoreTransferredResponse:
3244
+ description: "Completed transfer records including size, status, and timestamps."
3245
+ content:
3246
+ application/json:
3247
+ schema:
3248
+ type: object
3249
+ properties:
3250
+ transferred:
3251
+ type: array
3252
+ items:
3253
+ type: object
3254
+ properties:
3255
+ group:
3256
+ type: string
3257
+ description: "Stats group identifier this transfer belonged to."
3258
+ srcFs:
3259
+ type: string
3260
+ description: "Source remote or filesystem used for the transfer."
3261
+ dstFs:
3262
+ type: string
3263
+ description: "Destination remote or filesystem used for the transfer."
3264
+ srcRemote:
3265
+ type: string
3266
+ description: "Source path within `srcFs`, when provided."
3267
+ dstRemote:
3268
+ type: string
3269
+ description: "Destination path within `dstFs`, when provided."
3270
+ name:
3271
+ type: string
3272
+ size:
3273
+ type: integer
3274
+ bytes:
3275
+ type: integer
3276
+ checked:
3277
+ type: boolean
3278
+ what:
3279
+ type: string
3280
+ timestamp:
3281
+ type: integer
3282
+ error:
3283
+ type: string
3284
+ jobid:
3285
+ type: integer
3286
+ additionalProperties: true
3287
+ required:
3288
+ - group
3289
+ required:
3290
+ - transferred
3291
+ DebugSetGcPercentResponse:
3292
+ description: "Previous garbage collection target percentage returned after update."
3293
+ content:
3294
+ application/json:
3295
+ schema:
3296
+ type: object
3297
+ properties:
3298
+ existing-gc-percent:
3299
+ type: integer
3300
+ required:
3301
+ - existing-gc-percent
3302
+ DebugSetMutexProfileFractionResponse:
3303
+ description: "Previous mutex profiling sampling rate."
3304
+ content:
3305
+ application/json:
3306
+ schema:
3307
+ type: object
3308
+ properties:
3309
+ previousRate:
3310
+ type: integer
3311
+ required:
3312
+ - previousRate
3313
+ DebugSetSoftMemoryLimitResponse:
3314
+ description: "Previous soft memory limit before the change."
3315
+ content:
3316
+ application/json:
3317
+ schema:
3318
+ type: object
3319
+ properties:
3320
+ existing-mem-limit:
3321
+ type: integer
3322
+ required:
3323
+ - existing-mem-limit
3324
+ FscacheEntriesResponse:
3325
+ description: "Number of entries currently cached by the file system cache."
3326
+ content:
3327
+ application/json:
3328
+ schema:
3329
+ type: object
3330
+ properties:
3331
+ entries:
3332
+ type: integer
3333
+ required:
3334
+ - entries
3335
+ MountListmountsResponse:
3336
+ description: "Active mount points with source remote and mount time."
3337
+ content:
3338
+ application/json:
3339
+ schema:
3340
+ type: object
3341
+ properties:
3342
+ mountPoints:
3343
+ type: array
3344
+ items:
3345
+ type: object
3346
+ properties:
3347
+ Fs:
3348
+ type: string
3349
+ MountPoint:
3350
+ type: string
3351
+ MountedOn:
3352
+ type: string
3353
+ format: date-time
3354
+ required:
3355
+ - Fs
3356
+ - MountPoint
3357
+ - MountedOn
3358
+ additionalProperties: false
3359
+ required:
3360
+ - mountPoints
3361
+ MountTypesResponse:
3362
+ description: "List of mount backends available on this platform."
3363
+ content:
3364
+ application/json:
3365
+ schema:
3366
+ type: object
3367
+ properties:
3368
+ mountTypes:
3369
+ type: array
3370
+ items:
3371
+ type: string
3372
+ required:
3373
+ - mountTypes
3374
+ RcListResponse:
3375
+ description: "Metadata for every available RC command, including auth requirements."
3376
+ content:
3377
+ application/json:
3378
+ schema:
3379
+ type: object
3380
+ properties:
3381
+ commands:
3382
+ type: array
3383
+ items:
3384
+ type: object
3385
+ properties:
3386
+ Path:
3387
+ type: string
3388
+ Title:
3389
+ type: string
3390
+ AuthRequired:
3391
+ type: boolean
3392
+ Help:
3393
+ type: string
3394
+ NeedsRequest:
3395
+ type: boolean
3396
+ NeedsResponse:
3397
+ type: boolean
3398
+ additionalProperties: true
3399
+ required:
3400
+ - commands
3401
+ BackendCommandResponse:
3402
+ description: "Backend command output and any additional returned fields."
3403
+ content:
3404
+ application/json:
3405
+ schema:
3406
+ type: object
3407
+ properties:
3408
+ result:
3409
+ nullable: true
3410
+ description: Backend command result payload
3411
+ additionalProperties: true
3412
+ ConfigDumpResponse:
3413
+ description: "Entire rclone configuration grouped by remote."
3414
+ content:
3415
+ application/json:
3416
+ schema:
3417
+ type: object
3418
+ additionalProperties:
3419
+ type: object
3420
+ additionalProperties:
3421
+ type: string
3422
+ ConfigGetResponse:
3423
+ description: "Configuration key/value pairs for the requested remote."
3424
+ content:
3425
+ application/json:
3426
+ schema:
3427
+ type: object
3428
+ required:
3429
+ - type
3430
+ properties:
3431
+ type:
3432
+ type: string
3433
+ provider:
3434
+ type: string
3435
+ additionalProperties: true
3436
+ ConfigListremotesResponse:
3437
+ description: "Names of configured remotes."
3438
+ content:
3439
+ application/json:
3440
+ schema:
3441
+ type: object
3442
+ required:
3443
+ - remotes
3444
+ properties:
3445
+ remotes:
3446
+ type: array
3447
+ items:
3448
+ type: string
3449
+ ConfigPathsResponse:
3450
+ description: "Paths to the config file, cache directory, and temporary directory."
3451
+ content:
3452
+ application/json:
3453
+ schema:
3454
+ type: object
3455
+ properties:
3456
+ cache:
3457
+ type: string
3458
+ config:
3459
+ type: string
3460
+ temp:
3461
+ type: string
3462
+ required:
3463
+ - cache
3464
+ - config
3465
+ - temp
3466
+ ConfigProvidersResponse:
3467
+ description: "Available backend providers and their metadata."
3468
+ content:
3469
+ application/json:
3470
+ schema:
3471
+ type: object
3472
+ properties:
3473
+ providers:
3474
+ type: array
3475
+ items:
3476
+ $ref: "#/components/schemas/ConfigProvider"
3477
+ additionalProperties: true
3478
+ required:
3479
+ - providers
3480
+ CoreVersionResponse:
3481
+ description: "rclone version, build information, and runtime details."
3482
+ content:
3483
+ application/json:
3484
+ schema:
3485
+ type: object
3486
+ properties:
3487
+ version:
3488
+ type: string
3489
+ description: "Full semantic version string (e.g. 1.67.0)."
3490
+ os:
3491
+ type: string
3492
+ description: "Operating system rclone is running on (e.g. linux, darwin)."
3493
+ arch:
3494
+ type: string
3495
+ description: "CPU architecture (e.g. amd64, arm64)."
3496
+ decomposed:
3497
+ type: array
3498
+ items:
3499
+ type: number
3500
+ description: "Version number broken into components."
3501
+ isGit:
3502
+ type: boolean
3503
+ description: "True when built directly from a git checkout."
3504
+ isBeta:
3505
+ type: boolean
3506
+ description: "Indicates whether this build is a beta version."
3507
+ goVersion:
3508
+ type: string
3509
+ description: "Go toolchain version used to build rclone."
3510
+ linking:
3511
+ type: string
3512
+ description: "Linking mode for the binary (static or dynamic)."
3513
+ goTags:
3514
+ type: string
3515
+ description: "Space separated Go build tags, if any."
3516
+ required:
3517
+ - version
3518
+ - os
3519
+ - arch
3520
+ - decomposed
3521
+ - isGit
3522
+ - isBeta
3523
+ - goVersion
3524
+ - linking
3525
+ - goTags
3526
+ CoreStatsResponse:
3527
+ description: "Current transfer statistics including totals, rates, and recent activity."
3528
+ content:
3529
+ application/json:
3530
+ schema:
3531
+ type: object
3532
+ properties:
3533
+ bytes:
3534
+ type: number
3535
+ checks:
3536
+ type: number
3537
+ deletedDirs:
3538
+ type: number
3539
+ deletes:
3540
+ type: number
3541
+ elapsedTime:
3542
+ type: number
3543
+ errors:
3544
+ type: number
3545
+ eta:
3546
+ type: number
3547
+ nullable: true
3548
+ fatalError:
3549
+ type: boolean
3550
+ lastError:
3551
+ type: string
3552
+ retryError:
3553
+ type: boolean
3554
+ renames:
3555
+ type: number
3556
+ serverSideCopies:
3557
+ type: number
3558
+ serverSideCopyBytes:
3559
+ type: number
3560
+ serverSideMoveBytes:
3561
+ type: number
3562
+ serverSideMoves:
3563
+ type: number
3564
+ speed:
3565
+ type: number
3566
+ totalBytes:
3567
+ type: number
3568
+ totalChecks:
3569
+ type: number
3570
+ totalTransfers:
3571
+ type: number
3572
+ transferTime:
3573
+ type: number
3574
+ transfers:
3575
+ type: number
3576
+ transferring:
3577
+ type: array
3578
+ description: "Active transfers currently in progress grouped by stats group."
3579
+ items:
3580
+ $ref: "#/components/schemas/CoreStatsTransfer"
3581
+ checking:
3582
+ type: array
3583
+ description: "Objects currently undergoing verification operations."
3584
+ items:
3585
+ $ref: "#/components/schemas/CoreStatsChecking"
3586
+ required:
3587
+ - bytes
3588
+ - checks
3589
+ - deletedDirs
3590
+ - deletes
3591
+ - elapsedTime
3592
+ - errors
3593
+ - eta
3594
+ - fatalError
3595
+ - retryError
3596
+ - renames
3597
+ - serverSideCopies
3598
+ - serverSideCopyBytes
3599
+ - serverSideMoveBytes
3600
+ - serverSideMoves
3601
+ - speed
3602
+ - totalBytes
3603
+ - totalChecks
3604
+ - totalTransfers
3605
+ - transferTime
3606
+ - transfers
3607
+ JobListResponse:
3608
+ description: "Identifiers of active and recently completed async jobs."
3609
+ content:
3610
+ application/json:
3611
+ schema:
3612
+ type: object
3613
+ properties:
3614
+ executeId:
3615
+ type: string
3616
+ description: "Identifier for this rclone process."
3617
+ jobids:
3618
+ type: array
3619
+ items:
3620
+ type: number
3621
+ description: "Job IDs suitable for use with `job/status` and `job/stop`."
3622
+ required:
3623
+ - executeId
3624
+ - jobids
3625
+ JobStatusResponse:
3626
+ description: "Detailed status for a background job, including timing, success flag, and optional output."
3627
+ content:
3628
+ application/json:
3629
+ schema:
3630
+ type: object
3631
+ properties:
3632
+ finished:
3633
+ type: boolean
3634
+ description: "True once the job has completed."
3635
+ duration:
3636
+ type: number
3637
+ description: "Execution time in seconds."
3638
+ endTime:
3639
+ type: string
3640
+ description: "Timestamp when the job finished."
3641
+ error:
3642
+ type: string
3643
+ description: "Error message, or empty string on success."
3644
+ id:
3645
+ type: number
3646
+ description: "Job identifier."
3647
+ startTime:
3648
+ type: string
3649
+ description: "Timestamp when the job started."
3650
+ success:
3651
+ type: boolean
3652
+ description: "True if the job completed successfully."
3653
+ output:
3654
+ description: "Synchronous-style output payload when available."
3655
+ nullable: true
3656
+ progress:
3657
+ description: "Progress measurements supplied by the underlying command."
3658
+ nullable: true
3659
+ required:
3660
+ - finished
3661
+ - duration
3662
+ - endTime
3663
+ - error
3664
+ - id
3665
+ - startTime
3666
+ - success
3667
+ OperationsAboutResponse:
3668
+ description: "Quota and usage information from `operations/about`, including total, used, and free space."
3669
+ content:
3670
+ application/json:
3671
+ schema:
3672
+ type: object
3673
+ properties:
3674
+ total:
3675
+ type: number
3676
+ used:
3677
+ type: number
3678
+ free:
3679
+ type: number
3680
+ trashed:
3681
+ type: number
3682
+ other:
3683
+ type: number
3684
+ objects:
3685
+ type: number
3686
+ required:
3687
+ - total
3688
+ - used
3689
+ - free
3690
+ OperationsCheckResponse:
3691
+ description: "Comparison summary from `operations/check`, including missing, matching, and differing files."
3692
+ content:
3693
+ application/json:
3694
+ schema:
3695
+ type: object
3696
+ properties:
3697
+ success:
3698
+ type: boolean
3699
+ description: "True when the check completes without differences or errors."
3700
+ status:
3701
+ type: string
3702
+ description: "Human readable status string."
3703
+ hashType:
3704
+ type: string
3705
+ description: "Hash algorithm used for comparisons when applicable."
3706
+ combined:
3707
+ type: array
3708
+ items:
3709
+ type: string
3710
+ description: "Combined summary lines when `combined=true` is requested."
3711
+ missingOnSrc:
3712
+ type: array
3713
+ items:
3714
+ type: string
3715
+ description: "Files present on the destination but missing from the source."
3716
+ missingOnDst:
3717
+ type: array
3718
+ items:
3719
+ type: string
3720
+ description: "Files present on the source but missing from the destination."
3721
+ match:
3722
+ type: array
3723
+ items:
3724
+ type: string
3725
+ description: "Files that matched on both sides."
3726
+ differ:
3727
+ type: array
3728
+ items:
3729
+ type: string
3730
+ description: "Files that differed between source and destination."
3731
+ error:
3732
+ type: array
3733
+ items:
3734
+ type: string
3735
+ description: "Entries that produced errors during the check."
3736
+ required:
3737
+ - success
3738
+ - status
3739
+ OperationsListResponse:
3740
+ description: "Directory listing entries from `operations/list`, mirroring the `lsjson` format."
3741
+ content:
3742
+ application/json:
3743
+ schema:
3744
+ type: object
3745
+ properties:
3746
+ list:
3747
+ type: array
3748
+ description: "Array of entries equivalent to the items returned by `rclone lsjson`."
3749
+ items:
3750
+ type: object
3751
+ required:
3752
+ - Path
3753
+ - Name
3754
+ - IsDir
3755
+ properties:
3756
+ Path:
3757
+ type: string
3758
+ description: "Path relative to the requested remote root."
3759
+ Name:
3760
+ type: string
3761
+ description: "Base name of the entry."
3762
+ Size:
3763
+ type: number
3764
+ description: "Object size in bytes."
3765
+ MimeType:
3766
+ type: string
3767
+ description: "MIME type where available."
3768
+ ModTime:
3769
+ type: string
3770
+ description: "Modification timestamp in RFC3339 format."
3771
+ IsDir:
3772
+ type: boolean
3773
+ description: "True if the entry represents a directory."
3774
+ Hashes:
3775
+ type: object
3776
+ additionalProperties:
3777
+ type: string
3778
+ description: "Hash digests keyed by algorithm when requested."
3779
+ ID:
3780
+ type: string
3781
+ description: "Backend-specific identifier when provided."
3782
+ OrigID:
3783
+ type: string
3784
+ description: "Original backend identifier when recorded."
3785
+ IsBucket:
3786
+ type: boolean
3787
+ description: "True for bucket/root entries on bucket-based remotes."
3788
+ Tier:
3789
+ type: string
3790
+ description: "Storage class or tier, if supplied by the backend."
3791
+ Encrypted:
3792
+ type: string
3793
+ description: "Encrypted entry name when using crypt remotes."
3794
+ EncryptedPath:
3795
+ type: string
3796
+ description: "Encrypted path when using crypt remotes."
3797
+ Metadata:
3798
+ type: object
3799
+ additionalProperties:
3800
+ nullable: true
3801
+ description: "Backend-provided metadata map."
3802
+ required:
3803
+ - list
3804
+ OperationsStatResponse:
3805
+ description: "Metadata for a single file or directory from `operations/stat`."
3806
+ content:
3807
+ application/json:
3808
+ schema:
3809
+ type: object
3810
+ properties:
3811
+ Path:
3812
+ type: string
3813
+ description: "Path relative to the remote root."
3814
+ Name:
3815
+ type: string
3816
+ description: "Base name of the entry."
3817
+ Size:
3818
+ type: number
3819
+ description: "Object size in bytes."
3820
+ MimeType:
3821
+ type: string
3822
+ description: "MIME type where available."
3823
+ ModTime:
3824
+ type: string
3825
+ description: "Modification timestamp in RFC3339 format."
3826
+ IsDir:
3827
+ type: boolean
3828
+ description: "True if the entry is a directory."
3829
+ Hashes:
3830
+ type: object
3831
+ additionalProperties:
3832
+ type: string
3833
+ description: "Hash digests keyed by algorithm when requested."
3834
+ ID:
3835
+ type: string
3836
+ description: "Backend-specific identifier when provided."
3837
+ OrigID:
3838
+ type: string
3839
+ description: "Original backend identifier when recorded."
3840
+ IsBucket:
3841
+ type: boolean
3842
+ description: "True for bucket/root entries on bucket-based remotes."
3843
+ Tier:
3844
+ type: string
3845
+ description: "Storage class or tier, if supplied by the backend."
3846
+ Encrypted:
3847
+ type: string
3848
+ description: "Encrypted entry name when using crypt remotes."
3849
+ EncryptedPath:
3850
+ type: string
3851
+ description: "Encrypted path when using crypt remotes."
3852
+ Metadata:
3853
+ type: object
3854
+ additionalProperties:
3855
+ nullable: true
3856
+ description: "Backend-provided metadata map."
3857
+ required:
3858
+ - Path
3859
+ - Name
3860
+ - Size
3861
+ - MimeType
3862
+ - ModTime
3863
+ - IsDir
3864
+ OptionsBlocksResponse:
3865
+ description: "Names of option blocks that can be queried with `options/get` or `options/info`."
3866
+ content:
3867
+ application/json:
3868
+ schema:
3869
+ type: object
3870
+ properties:
3871
+ options:
3872
+ type: array
3873
+ items:
3874
+ type: string
3875
+ required:
3876
+ - options
3877
+ OptionsGetResponse:
3878
+ description: "Current global option values keyed by block name."
3879
+ content:
3880
+ application/json:
3881
+ schema:
3882
+ type: object
3883
+ required:
3884
+ - dlna
3885
+ - filter
3886
+ - ftp
3887
+ - http
3888
+ - log
3889
+ - main
3890
+ - mount
3891
+ - nfs
3892
+ - proxy
3893
+ - rc
3894
+ - restic
3895
+ - s3
3896
+ - sftp
3897
+ - vfs
3898
+ - webdav
3899
+ properties:
3900
+ dlna:
3901
+ type: object
3902
+ additionalProperties: true
3903
+ filter:
3904
+ type: object
3905
+ additionalProperties: true
3906
+ ftp:
3907
+ type: object
3908
+ additionalProperties: true
3909
+ http:
3910
+ type: object
3911
+ additionalProperties: true
3912
+ log:
3913
+ type: object
3914
+ additionalProperties: true
3915
+ main:
3916
+ type: object
3917
+ additionalProperties: true
3918
+ mount:
3919
+ type: object
3920
+ additionalProperties: true
3921
+ nfs:
3922
+ type: object
3923
+ additionalProperties: true
3924
+ proxy:
3925
+ type: object
3926
+ additionalProperties: true
3927
+ rc:
3928
+ type: object
3929
+ additionalProperties: true
3930
+ restic:
3931
+ type: object
3932
+ additionalProperties: true
3933
+ s3:
3934
+ type: object
3935
+ additionalProperties: true
3936
+ sftp:
3937
+ type: object
3938
+ additionalProperties: true
3939
+ vfs:
3940
+ type: object
3941
+ additionalProperties: true
3942
+ webdav:
3943
+ type: object
3944
+ additionalProperties: true
3945
+ additionalProperties: true
3946
+ OptionsInfoResponse:
3947
+ description: "Metadata describing available options, organised by block."
3948
+ content:
3949
+ application/json:
3950
+ schema:
3951
+ type: object
3952
+ required:
3953
+ - dlna
3954
+ - filter
3955
+ - ftp
3956
+ - http
3957
+ - log
3958
+ - main
3959
+ - mount
3960
+ - nfs
3961
+ - proxy
3962
+ - rc
3963
+ - restic
3964
+ - s3
3965
+ - sftp
3966
+ - vfs
3967
+ - webdav
3968
+ properties:
3969
+ dlna: &OptionsInfoBlockSchema
3970
+ type: array
3971
+ items:
3972
+ $ref: "#/components/schemas/OptionsInfoOption"
3973
+ filter: *OptionsInfoBlockSchema
3974
+ ftp: *OptionsInfoBlockSchema
3975
+ http: *OptionsInfoBlockSchema
3976
+ log: *OptionsInfoBlockSchema
3977
+ main: *OptionsInfoBlockSchema
3978
+ mount: *OptionsInfoBlockSchema
3979
+ nfs: *OptionsInfoBlockSchema
3980
+ proxy: *OptionsInfoBlockSchema
3981
+ rc: *OptionsInfoBlockSchema
3982
+ restic: *OptionsInfoBlockSchema
3983
+ s3: *OptionsInfoBlockSchema
3984
+ sftp: *OptionsInfoBlockSchema
3985
+ vfs: *OptionsInfoBlockSchema
3986
+ webdav: *OptionsInfoBlockSchema
3987
+ additionalProperties: *OptionsInfoBlockSchema
3988
+ OptionsLocalResponse:
3989
+ description: "Effective option values for the current request, separated into config and filter sections."
3990
+ content:
3991
+ application/json:
3992
+ schema:
3993
+ type: object
3994
+ properties:
3995
+ config:
3996
+ type: object
3997
+ properties:
3998
+ AskPassword:
3999
+ type: boolean
4000
+ AutoConfirm:
4001
+ type: boolean
4002
+ BackupDir:
4003
+ type: string
4004
+ BindAddr:
4005
+ type: string
4006
+ BufferSize:
4007
+ type: number
4008
+ BwLimit:
4009
+ type: string
4010
+ BwLimitFile:
4011
+ type: string
4012
+ CaCert:
4013
+ type: array
4014
+ items:
4015
+ type: string
4016
+ CheckFirst:
4017
+ type: boolean
4018
+ CheckSum:
4019
+ type: boolean
4020
+ Checkers:
4021
+ type: number
4022
+ ClientCert:
4023
+ type: string
4024
+ ClientKey:
4025
+ type: string
4026
+ CompareDest:
4027
+ type: array
4028
+ items:
4029
+ type: string
4030
+ ConnectTimeout:
4031
+ type: number
4032
+ Cookie:
4033
+ type: boolean
4034
+ CopyDest:
4035
+ type: array
4036
+ items:
4037
+ type: string
4038
+ CutoffMode:
4039
+ type: string
4040
+ DataRateUnit:
4041
+ type: string
4042
+ DefaultTime:
4043
+ type: string
4044
+ DeleteMode:
4045
+ type: number
4046
+ DisableFeatures:
4047
+ type: string
4048
+ format: "null"
4049
+ nullable: true
4050
+ DisableHTTP2:
4051
+ type: boolean
4052
+ DisableHTTPKeepAlives:
4053
+ type: boolean
4054
+ DownloadHeaders:
4055
+ type: string
4056
+ format: "null"
4057
+ nullable: true
4058
+ DryRun:
4059
+ type: boolean
4060
+ Dump:
4061
+ type: string
4062
+ ErrorOnNoTransfer:
4063
+ type: boolean
4064
+ ExpectContinueTimeout:
4065
+ type: number
4066
+ FixCase:
4067
+ type: boolean
4068
+ FsCacheExpireDuration:
4069
+ type: number
4070
+ FsCacheExpireInterval:
4071
+ type: number
4072
+ Headers:
4073
+ type: string
4074
+ format: "null"
4075
+ nullable: true
4076
+ HumanReadable:
4077
+ type: boolean
4078
+ IgnoreCaseSync:
4079
+ type: boolean
4080
+ IgnoreChecksum:
4081
+ type: boolean
4082
+ IgnoreErrors:
4083
+ type: boolean
4084
+ IgnoreExisting:
4085
+ type: boolean
4086
+ IgnoreSize:
4087
+ type: boolean
4088
+ IgnoreTimes:
4089
+ type: boolean
4090
+ Immutable:
4091
+ type: boolean
4092
+ Inplace:
4093
+ type: boolean
4094
+ InsecureSkipVerify:
4095
+ type: boolean
4096
+ Interactive:
4097
+ type: boolean
4098
+ KvLockTime:
4099
+ type: number
4100
+ Links:
4101
+ type: boolean
4102
+ LogLevel:
4103
+ type: string
4104
+ LowLevelRetries:
4105
+ type: number
4106
+ MaxBacklog:
4107
+ type: number
4108
+ MaxBufferMemory:
4109
+ type: number
4110
+ MaxDelete:
4111
+ type: number
4112
+ MaxDeleteSize:
4113
+ type: number
4114
+ MaxDepth:
4115
+ type: number
4116
+ MaxDuration:
4117
+ type: number
4118
+ MaxStatsGroups:
4119
+ type: number
4120
+ MaxTransfer:
4121
+ type: number
4122
+ Metadata:
4123
+ type: boolean
4124
+ MetadataMapper:
4125
+ type: string
4126
+ format: "null"
4127
+ nullable: true
4128
+ MetadataSet:
4129
+ type: string
4130
+ format: "null"
4131
+ nullable: true
4132
+ ModifyWindow:
4133
+ type: number
4134
+ MultiThreadChunkSize:
4135
+ type: number
4136
+ MultiThreadCutoff:
4137
+ type: number
4138
+ MultiThreadSet:
4139
+ type: boolean
4140
+ MultiThreadStreams:
4141
+ type: number
4142
+ MultiThreadWriteBufferSize:
4143
+ type: number
4144
+ NoCheckDest:
4145
+ type: boolean
4146
+ NoConsole:
4147
+ type: boolean
4148
+ NoGzip:
4149
+ type: boolean
4150
+ NoTraverse:
4151
+ type: boolean
4152
+ NoUnicodeNormalization:
4153
+ type: boolean
4154
+ NoUpdateDirModTime:
4155
+ type: boolean
4156
+ NoUpdateModTime:
4157
+ type: boolean
4158
+ OrderBy:
4159
+ type: string
4160
+ PartialSuffix:
4161
+ type: string
4162
+ PasswordCommand:
4163
+ type: string
4164
+ format: "null"
4165
+ nullable: true
4166
+ Progress:
4167
+ type: boolean
4168
+ ProgressTerminalTitle:
4169
+ type: boolean
4170
+ RefreshTimes:
4171
+ type: boolean
4172
+ Retries:
4173
+ type: number
4174
+ RetriesInterval:
4175
+ type: number
4176
+ ServerSideAcrossConfigs:
4177
+ type: boolean
4178
+ SizeOnly:
4179
+ type: boolean
4180
+ StatsFileNameLength:
4181
+ type: number
4182
+ StatsLogLevel:
4183
+ type: string
4184
+ StatsOneLine:
4185
+ type: boolean
4186
+ StatsOneLineDate:
4187
+ type: boolean
4188
+ StatsOneLineDateFormat:
4189
+ type: string
4190
+ StreamingUploadCutoff:
4191
+ type: number
4192
+ Suffix:
4193
+ type: string
4194
+ SuffixKeepExtension:
4195
+ type: boolean
4196
+ TPSLimit:
4197
+ type: number
4198
+ TPSLimitBurst:
4199
+ type: number
4200
+ TerminalColorMode:
4201
+ type: string
4202
+ Timeout:
4203
+ type: number
4204
+ TrackRenames:
4205
+ type: boolean
4206
+ TrackRenamesStrategy:
4207
+ type: string
4208
+ TrafficClass:
4209
+ type: number
4210
+ Transfers:
4211
+ type: number
4212
+ UpdateOlder:
4213
+ type: boolean
4214
+ UploadHeaders:
4215
+ type: string
4216
+ format: "null"
4217
+ nullable: true
4218
+ UseJSONLog:
4219
+ type: boolean
4220
+ UseListR:
4221
+ type: boolean
4222
+ UseMmap:
4223
+ type: boolean
4224
+ UseServerModTime:
4225
+ type: boolean
4226
+ UserAgent:
4227
+ type: string
4228
+ required:
4229
+ - AskPassword
4230
+ - AutoConfirm
4231
+ - BackupDir
4232
+ - BindAddr
4233
+ - BufferSize
4234
+ - BwLimit
4235
+ - BwLimitFile
4236
+ - CaCert
4237
+ - CheckFirst
4238
+ - CheckSum
4239
+ - Checkers
4240
+ - ClientCert
4241
+ - ClientKey
4242
+ - CompareDest
4243
+ - ConnectTimeout
4244
+ - Cookie
4245
+ - CopyDest
4246
+ - CutoffMode
4247
+ - DataRateUnit
4248
+ - DefaultTime
4249
+ - DeleteMode
4250
+ - DisableFeatures
4251
+ - DisableHTTP2
4252
+ - DisableHTTPKeepAlives
4253
+ - DownloadHeaders
4254
+ - DryRun
4255
+ - Dump
4256
+ - ErrorOnNoTransfer
4257
+ - ExpectContinueTimeout
4258
+ - FixCase
4259
+ - FsCacheExpireDuration
4260
+ - FsCacheExpireInterval
4261
+ - Headers
4262
+ - HumanReadable
4263
+ - IgnoreCaseSync
4264
+ - IgnoreChecksum
4265
+ - IgnoreErrors
4266
+ - IgnoreExisting
4267
+ - IgnoreSize
4268
+ - IgnoreTimes
4269
+ - Immutable
4270
+ - Inplace
4271
+ - InsecureSkipVerify
4272
+ - Interactive
4273
+ - KvLockTime
4274
+ - Links
4275
+ - LogLevel
4276
+ - LowLevelRetries
4277
+ - MaxBacklog
4278
+ - MaxBufferMemory
4279
+ - MaxDelete
4280
+ - MaxDeleteSize
4281
+ - MaxDepth
4282
+ - MaxDuration
4283
+ - MaxStatsGroups
4284
+ - MaxTransfer
4285
+ - Metadata
4286
+ - MetadataMapper
4287
+ - MetadataSet
4288
+ - ModifyWindow
4289
+ - MultiThreadChunkSize
4290
+ - MultiThreadCutoff
4291
+ - MultiThreadSet
4292
+ - MultiThreadStreams
4293
+ - MultiThreadWriteBufferSize
4294
+ - NoCheckDest
4295
+ - NoConsole
4296
+ - NoGzip
4297
+ - NoTraverse
4298
+ - NoUnicodeNormalization
4299
+ - NoUpdateDirModTime
4300
+ - NoUpdateModTime
4301
+ - OrderBy
4302
+ - PartialSuffix
4303
+ - PasswordCommand
4304
+ - Progress
4305
+ - ProgressTerminalTitle
4306
+ - RefreshTimes
4307
+ - Retries
4308
+ - RetriesInterval
4309
+ - ServerSideAcrossConfigs
4310
+ - SizeOnly
4311
+ - StatsFileNameLength
4312
+ - StatsLogLevel
4313
+ - StatsOneLine
4314
+ - StatsOneLineDate
4315
+ - StatsOneLineDateFormat
4316
+ - StreamingUploadCutoff
4317
+ - Suffix
4318
+ - SuffixKeepExtension
4319
+ - TPSLimit
4320
+ - TPSLimitBurst
4321
+ - TerminalColorMode
4322
+ - Timeout
4323
+ - TrackRenames
4324
+ - TrackRenamesStrategy
4325
+ - TrafficClass
4326
+ - Transfers
4327
+ - UpdateOlder
4328
+ - UploadHeaders
4329
+ - UseJSONLog
4330
+ - UseListR
4331
+ - UseMmap
4332
+ - UseServerModTime
4333
+ - UserAgent
4334
+ filter:
4335
+ type: object
4336
+ properties:
4337
+ DeleteExcluded:
4338
+ type: boolean
4339
+ ExcludeFile:
4340
+ type: array
4341
+ items:
4342
+ type: string
4343
+ ExcludeFrom:
4344
+ type: array
4345
+ items:
4346
+ type: string
4347
+ ExcludeRule:
4348
+ type: array
4349
+ items:
4350
+ type: string
4351
+ FilesFrom:
4352
+ type: array
4353
+ items:
4354
+ type: string
4355
+ FilesFromRaw:
4356
+ type: array
4357
+ items:
4358
+ type: string
4359
+ FilterFrom:
4360
+ type: array
4361
+ items:
4362
+ type: string
4363
+ FilterRule:
4364
+ type: array
4365
+ items:
4366
+ type: string
4367
+ HashFilter:
4368
+ type: string
4369
+ IgnoreCase:
4370
+ type: boolean
4371
+ IncludeFrom:
4372
+ type: array
4373
+ items:
4374
+ type: string
4375
+ IncludeRule:
4376
+ type: array
4377
+ items:
4378
+ type: string
4379
+ MaxAge:
4380
+ type: number
4381
+ MaxSize:
4382
+ type: number
4383
+ MetaRules:
4384
+ type: object
4385
+ properties:
4386
+ ExcludeFrom:
4387
+ type: array
4388
+ items:
4389
+ type: string
4390
+ ExcludeRule:
4391
+ type: array
4392
+ items:
4393
+ type: string
4394
+ FilterFrom:
4395
+ type: array
4396
+ items:
4397
+ type: string
4398
+ FilterRule:
4399
+ type: array
4400
+ items:
4401
+ type: string
4402
+ IncludeFrom:
4403
+ type: array
4404
+ items:
4405
+ type: string
4406
+ IncludeRule:
4407
+ type: array
4408
+ items:
4409
+ type: string
4410
+ required:
4411
+ - ExcludeFrom
4412
+ - ExcludeRule
4413
+ - FilterFrom
4414
+ - FilterRule
4415
+ - IncludeFrom
4416
+ - IncludeRule
4417
+ MinAge:
4418
+ type: number
4419
+ MinSize:
4420
+ type: number
4421
+ required:
4422
+ - DeleteExcluded
4423
+ - ExcludeFile
4424
+ - ExcludeFrom
4425
+ - ExcludeRule
4426
+ - FilesFrom
4427
+ - FilesFromRaw
4428
+ - FilterFrom
4429
+ - FilterRule
4430
+ - HashFilter
4431
+ - IgnoreCase
4432
+ - IncludeFrom
4433
+ - IncludeRule
4434
+ - MaxAge
4435
+ - MaxSize
4436
+ - MetaRules
4437
+ - MinAge
4438
+ - MinSize
4439
+ required:
4440
+ - config
4441
+ - filter
4442
+ ServeListResponse:
4443
+ description: "List of active `serve` instances, including their IDs, bind addresses, and parameters."
4444
+ content:
4445
+ application/json:
4446
+ schema:
4447
+ type: object
4448
+ properties:
4449
+ list:
4450
+ type: array
4451
+ items:
4452
+ type: object
4453
+ properties:
4454
+ id:
4455
+ type: string
4456
+ description: "Identifier returned by `serve/start`."
4457
+ addr:
4458
+ type: string
4459
+ description: "Address and port the server is listening on."
4460
+ params:
4461
+ type: object
4462
+ required:
4463
+ - id
4464
+ - fs
4465
+ - type
4466
+ properties:
4467
+ fs:
4468
+ type: string
4469
+ type:
4470
+ type: string
4471
+ opt:
4472
+ type: object
4473
+ additionalProperties: true
4474
+ vfsOpt:
4475
+ type: object
4476
+ additionalProperties: true
4477
+ additionalProperties: true
4478
+ description: "Serve configuration parameters supplied at startup."
4479
+ additionalProperties: false
4480
+ required:
4481
+ - id
4482
+ - addr
4483
+ required:
4484
+ - list
4485
+ ServeStartResponse:
4486
+ description: "Confirmation of a newly started server, including ID and bound address."
4487
+ content:
4488
+ application/json:
4489
+ schema:
4490
+ type: object
4491
+ properties:
4492
+ addr:
4493
+ type: string
4494
+ description: "Address and port the server is listening on."
4495
+ id:
4496
+ type: string
4497
+ description: "Identifier to pass to `serve/stop`."
4498
+ required:
4499
+ - addr
4500
+ - id
4501
+ VfsForgetResponse:
4502
+ description: "Paths evicted from the VFS directory cache."
4503
+ content:
4504
+ application/json:
4505
+ schema:
4506
+ type: object
4507
+ properties:
4508
+ forgotten:
4509
+ type: array
4510
+ items:
4511
+ type: string
4512
+ description: "Paths that were successfully forgotten."
4513
+ required:
4514
+ - forgotten
4515
+ VfsListResponse:
4516
+ description: "Identifiers for the VFS instances currently in use."
4517
+ content:
4518
+ application/json:
4519
+ schema:
4520
+ type: object
4521
+ properties:
4522
+ vfses:
4523
+ type: array
4524
+ items:
4525
+ type: string
4526
+ description: "VFS name that can be used with other VFS endpoints."
4527
+ required:
4528
+ - vfses
4529
+ VfsPollIntervalResponse:
4530
+ description: "Status of the poll-interval setting, possibly including the new interval."
4531
+ content:
4532
+ application/json:
4533
+ schema:
4534
+ type: object
4535
+ additionalProperties: true
4536
+ VfsQueueResponse:
4537
+ description: "Upload queue entries for the selected VFS."
4538
+ content:
4539
+ application/json:
4540
+ schema:
4541
+ type: object
4542
+ properties:
4543
+ queued:
4544
+ type: array
4545
+ items:
4546
+ type: object
4547
+ additionalProperties: true
4548
+ description: "Queued item metadata such as name, size, expiry, and upload state."
4549
+ VfsRefreshResponse:
4550
+ description: "Acknowledgement of directories refreshed in the VFS cache."
4551
+ content:
4552
+ application/json:
4553
+ schema:
4554
+ type: object
4555
+ properties:
4556
+ result:
4557
+ type: object
4558
+ additionalProperties:
4559
+ type: string
4560
+ description: "Map of refreshed directories to status messages."
4561
+ required:
4562
+ - result
4563
+ VfsStatsResponse:
4564
+ description: "Runtime statistics for a VFS, including disk cache and metadata cache state."
4565
+ content:
4566
+ application/json:
4567
+ schema:
4568
+ type: object
4569
+ properties:
4570
+ fs:
4571
+ type: string
4572
+ description: "Name of the VFS."
4573
+ inUse:
4574
+ type: integer
4575
+ description: "Number of active references to the VFS."
4576
+ diskCache:
4577
+ type: object
4578
+ nullable: true
4579
+ additionalProperties: true
4580
+ description: "Disk cache metrics when caching is enabled."
4581
+ metadataCache:
4582
+ type: object
4583
+ additionalProperties:
4584
+ type: integer
4585
+ description: "In-memory metadata cache counters."
4586
+ opt:
4587
+ type: object
4588
+ additionalProperties: true
4589
+ description: "Effective options applied to the VFS."
4590
+ required:
4591
+ - fs
4592
+ - inUse
4593
+ - metadataCache
4594
+ - opt
4595
+ PluginsctlGetPluginsForTypeResponse:
4596
+ description: "Loaded plugin metadata for the requested MIME type."
4597
+ content:
4598
+ application/json:
4599
+ schema:
4600
+ type: object
4601
+ properties:
4602
+ loadedPlugins:
4603
+ type: object
4604
+ additionalProperties:
4605
+ type: object
4606
+ additionalProperties: true
4607
+ description: "Installed plugins keyed by repository name."
4608
+ loadedTestPlugins:
4609
+ type: object
4610
+ additionalProperties:
4611
+ type: object
4612
+ additionalProperties: true
4613
+ description: "Installed test plugins keyed by repository name."
4614
+ required:
4615
+ - loadedPlugins
4616
+ - loadedTestPlugins
4617
+ PluginsctlListPluginsResponse:
4618
+ description: "Lists installed production and test plugins with their metadata."
4619
+ content:
4620
+ application/json:
4621
+ schema:
4622
+ type: object
4623
+ properties:
4624
+ loadedPlugins:
4625
+ type: array
4626
+ items:
4627
+ type: object
4628
+ additionalProperties: true
4629
+ description: "Metadata entries for installed plugins."
4630
+ testPlugins:
4631
+ type: array
4632
+ items:
4633
+ type: object
4634
+ additionalProperties: true
4635
+ description: "Metadata entries for installed test plugins."
4636
+ required:
4637
+ - loadedPlugins
4638
+ - testPlugins
4639
+ PluginsctlListTestPluginsResponse:
4640
+ description: "Metadata for installed test plugins keyed by repository name."
4641
+ content:
4642
+ application/json:
4643
+ schema:
4644
+ type: object
4645
+ properties:
4646
+ loadedTestPlugins:
4647
+ type: object
4648
+ additionalProperties:
4649
+ type: object
4650
+ additionalProperties: true
4651
+ description: "Installed test plugin metadata keyed by repository."
4652
+ required:
4653
+ - loadedTestPlugins
4654
+ schemas:
4655
+ RcError:
4656
+ type: object
4657
+ required:
4658
+ - error
4659
+ - status
4660
+ - path
4661
+ - input
4662
+ properties:
4663
+ error:
4664
+ type: string
4665
+ status:
4666
+ type: integer
4667
+ path:
4668
+ type: string
4669
+ input:
4670
+ type: object
4671
+ nullable: true
4672
+ additionalProperties:
4673
+ nullable: true
4674
+ description: "Original request parameters echoed for debugging."
4675
+ ConfigProvider:
4676
+ type: object
4677
+ properties:
4678
+ Aliases:
4679
+ type: array
4680
+ nullable: true
4681
+ items:
4682
+ type: string
4683
+ CommandHelp:
4684
+ type: array
4685
+ nullable: true
4686
+ items:
4687
+ $ref: "#/components/schemas/ConfigProviderCommandHelp"
4688
+ Description:
4689
+ type: string
4690
+ Hide:
4691
+ type: boolean
4692
+ MetadataInfo:
4693
+ nullable: true
4694
+ allOf:
4695
+ - $ref: "#/components/schemas/ConfigProviderMetadataInfo"
4696
+ Name:
4697
+ type: string
4698
+ Options:
4699
+ type: array
4700
+ items:
4701
+ $ref: "#/components/schemas/ConfigProviderOption"
4702
+ Prefix:
4703
+ type: string
4704
+ required:
4705
+ - Name
4706
+ - Description
4707
+ - Options
4708
+ - Prefix
4709
+ additionalProperties: true
4710
+ ConfigProviderCommandHelp:
4711
+ type: object
4712
+ properties:
4713
+ Long:
4714
+ type: string
4715
+ Name:
4716
+ type: string
4717
+ Opts:
4718
+ type: object
4719
+ nullable: true
4720
+ additionalProperties: true
4721
+ Short:
4722
+ type: string
4723
+ additionalProperties: true
4724
+ ConfigProviderMetadataInfo:
4725
+ type: object
4726
+ properties:
4727
+ Help:
4728
+ type: string
4729
+ System:
4730
+ type: object
4731
+ nullable: true
4732
+ additionalProperties:
4733
+ $ref: "#/components/schemas/ConfigProviderMetadataSystemEntry"
4734
+ additionalProperties: true
4735
+ ConfigProviderMetadataSystemEntry:
4736
+ type: object
4737
+ properties:
4738
+ Example:
4739
+ type: string
4740
+ Help:
4741
+ type: string
4742
+ ReadOnly:
4743
+ type: boolean
4744
+ Type:
4745
+ type: string
4746
+ additionalProperties: true
4747
+ OptionsInfoOptionExample:
4748
+ type: object
4749
+ properties:
4750
+ Value:
4751
+ type: string
4752
+ Help:
4753
+ type: string
4754
+ required:
4755
+ - Value
4756
+ - Help
4757
+ additionalProperties: true
4758
+ OptionsInfoOption:
4759
+ type: object
4760
+ properties:
4761
+ Name:
4762
+ type: string
4763
+ FieldName:
4764
+ type: string
4765
+ Help:
4766
+ type: string
4767
+ Default:
4768
+ description: "Default value for this option."
4769
+ anyOf:
4770
+ - type: array
4771
+ items:
4772
+ type: string
4773
+ - type: boolean
4774
+ - type: number
4775
+ - type: string
4776
+ - type: object
4777
+ properties:
4778
+ Value:
4779
+ type: boolean
4780
+ Valid:
4781
+ type: boolean
4782
+ required:
4783
+ - Value
4784
+ - Valid
4785
+ additionalProperties: false
4786
+ Value:
4787
+ nullable: true
4788
+ anyOf:
4789
+ - type: boolean
4790
+ - type: number
4791
+ Hide:
4792
+ type: integer
4793
+ Required:
4794
+ type: boolean
4795
+ IsPassword:
4796
+ type: boolean
4797
+ NoPrefix:
4798
+ type: boolean
4799
+ Advanced:
4800
+ type: boolean
4801
+ Exclusive:
4802
+ type: boolean
4803
+ Sensitive:
4804
+ type: boolean
4805
+ DefaultStr:
4806
+ type: string
4807
+ ValueStr:
4808
+ type: string
4809
+ Type:
4810
+ type: string
4811
+ Groups:
4812
+ type: string
4813
+ ShortOpt:
4814
+ type: string
4815
+ Examples:
4816
+ type: array
4817
+ items:
4818
+ $ref: "#/components/schemas/OptionsInfoOptionExample"
4819
+ required:
4820
+ - Name
4821
+ - FieldName
4822
+ - Help
4823
+ - Default
4824
+ - Value
4825
+ - Hide
4826
+ - Required
4827
+ - IsPassword
4828
+ - NoPrefix
4829
+ - Advanced
4830
+ - Exclusive
4831
+ - Sensitive
4832
+ - DefaultStr
4833
+ - ValueStr
4834
+ - Type
4835
+ additionalProperties: true
4836
+ ConfigProviderOption:
4837
+ type: object
4838
+ properties:
4839
+ Advanced:
4840
+ type: boolean
4841
+ Default:
4842
+ $ref: "#/components/schemas/ConfigProviderOptionAny"
4843
+ DefaultStr:
4844
+ type: string
4845
+ Exclusive:
4846
+ type: boolean
4847
+ FieldName:
4848
+ type: string
4849
+ Help:
4850
+ type: string
4851
+ Hide:
4852
+ type: number
4853
+ IsPassword:
4854
+ type: boolean
4855
+ Name:
4856
+ type: string
4857
+ NoPrefix:
4858
+ type: boolean
4859
+ Required:
4860
+ type: boolean
4861
+ Sensitive:
4862
+ type: boolean
4863
+ Type:
4864
+ $ref: "#/components/schemas/ConfigProviderOptionType"
4865
+ Value:
4866
+ $ref: "#/components/schemas/ConfigProviderOptionAny"
4867
+ ValueStr:
4868
+ type: string
4869
+ Examples:
4870
+ type: array
4871
+ items:
4872
+ $ref: "#/components/schemas/ConfigProviderOptionExample"
4873
+ ShortOpt:
4874
+ type: string
4875
+ Provider:
4876
+ type: string
4877
+ additionalProperties: true
4878
+ required:
4879
+ - Name
4880
+ - FieldName
4881
+ - Help
4882
+ - Default
4883
+ - Value
4884
+ - Hide
4885
+ - Required
4886
+ - IsPassword
4887
+ - NoPrefix
4888
+ - Advanced
4889
+ - Exclusive
4890
+ - Sensitive
4891
+ - DefaultStr
4892
+ - ValueStr
4893
+ - Type
4894
+ ConfigProviderOptionExample:
4895
+ type: object
4896
+ properties:
4897
+ Help:
4898
+ type: string
4899
+ Value:
4900
+ type: string
4901
+ Provider:
4902
+ type: string
4903
+ additionalProperties: true
4904
+ required:
4905
+ - Help
4906
+ - Value
4907
+ ConfigProviderOptionAny:
4908
+ description: "Arbitrary JSON value."
4909
+ anyOf:
4910
+ - type: string
4911
+ - type: number
4912
+ - type: boolean
4913
+ - type: array
4914
+ items: {}
4915
+ - type: object
4916
+ additionalProperties: true
4917
+ nullable: true
4918
+ ConfigProviderOptionType:
4919
+ type: string
4920
+ enum:
4921
+ - Bits
4922
+ - bool
4923
+ - CommaSepList
4924
+ - Duration
4925
+ - Encoding
4926
+ - int
4927
+ - mtime|atime|btime|ctime
4928
+ - SizeSuffix
4929
+ - SpaceSepList
4930
+ - string
4931
+ - stringArray
4932
+ - Time
4933
+ - Tristate
4934
+ CoreStatsTransfer:
4935
+ type: object
4936
+ description: "Progress metrics for an in-flight transfer."
4937
+ properties:
4938
+ bytes:
4939
+ type: number
4940
+ description: "Bytes transferred so far for this object."
4941
+ eta:
4942
+ type: number
4943
+ nullable: true
4944
+ description: "Estimated seconds remaining, when available."
4945
+ group:
4946
+ type: string
4947
+ description: "Stats group name associated with this transfer."
4948
+ name:
4949
+ type: string
4950
+ description: "Remote path of the object being transferred."
4951
+ percentage:
4952
+ type: number
4953
+ description: "Completion percentage from 0-100."
4954
+ size:
4955
+ type: number
4956
+ description: "Total size in bytes of the object."
4957
+ speed:
4958
+ type: number
4959
+ description: "Current transfer speed in bytes per second."
4960
+ additionalProperties: true
4961
+ CoreStatsChecking:
4962
+ type: object
4963
+ description: "Metadata for an item currently undergoing verification."
4964
+ properties:
4965
+ group:
4966
+ type: string
4967
+ description: "Stats group name associated with this verification."
4968
+ name:
4969
+ type: string
4970
+ description: "Remote path of the object being verified."
4971
+ size:
4972
+ type: number
4973
+ description: "Total size in bytes of the object."
4974
+ additionalProperties: true