rclone-openapi 1.0.13 → 1.0.15

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