rclone-openapi 1.0.14 → 1.0.16

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 CHANGED
@@ -1,8 +1,7 @@
1
- # openapi: "3.0.1"
2
1
  openapi: 3.1.0
3
2
  info:
4
3
  title: Rclone RC API
5
- version: 0.1.2
4
+ version: 0.1.3
6
5
  description: "Full OpenAPI specification for the Rclone RC API."
7
6
  contact:
8
7
  name: GitHub Repository
@@ -19,7 +18,6 @@ paths:
19
18
  summary: "Echo request parameters"
20
19
  description: "Returns all supplied parameters unchanged so you can verify RC connectivity."
21
20
  tags: []
22
- operationId: rcNoop
23
21
  parameters:
24
22
  - $ref: "#/components/parameters/Rc_NoopPostAdditionalParam"
25
23
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -30,12 +28,12 @@ paths:
30
28
  $ref: "#/components/responses/RcError"
31
29
  "5XX":
32
30
  $ref: "#/components/responses/RcError"
31
+ operationId: rcNoop
33
32
  /operations/cleanup:
34
33
  post:
35
34
  summary: "Remove trashed files"
36
35
  description: "Permanently removes trashed objects from the specified remote path."
37
36
  tags: []
38
- operationId: operationsCleanup
39
37
  parameters:
40
38
  - $ref: "#/components/parameters/Operations_CleanupPostFsParam"
41
39
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -47,12 +45,12 @@ paths:
47
45
  $ref: "#/components/responses/RcError"
48
46
  "5XX":
49
47
  $ref: "#/components/responses/RcError"
48
+ operationId: operationsCleanup
50
49
  /operations/copyfile:
51
50
  post:
52
51
  summary: "Copy a single file"
53
52
  description: "Copies one object from a source remote and path to a destination remote and path."
54
53
  tags: []
55
- operationId: operationsCopyfile
56
54
  parameters:
57
55
  - $ref: "#/components/parameters/Operations_CopyfilePostSrcFsParam"
58
56
  - $ref: "#/components/parameters/Operations_CopyfilePostSrcRemoteParam"
@@ -67,12 +65,12 @@ paths:
67
65
  $ref: "#/components/responses/RcError"
68
66
  "5XX":
69
67
  $ref: "#/components/responses/RcError"
68
+ operationId: operationsCopyfile
70
69
  /operations/copyurl:
71
70
  post:
72
71
  summary: "Copy from URL"
73
72
  description: "Downloads a public URL and stores it at the requested remote path."
74
73
  tags: []
75
- operationId: operationsCopyurl
76
74
  parameters:
77
75
  - $ref: "#/components/parameters/Operations_CopyurlPostFsParam"
78
76
  - $ref: "#/components/parameters/Operations_CopyurlPostRemoteParam"
@@ -87,12 +85,12 @@ paths:
87
85
  $ref: "#/components/responses/RcError"
88
86
  "5XX":
89
87
  $ref: "#/components/responses/RcError"
88
+ operationId: operationsCopyurl
90
89
  /operations/delete:
91
90
  post:
92
91
  summary: "Delete objects in path"
93
92
  description: "Deletes matching files and directories for the provided remote, honouring filters and config overrides."
94
93
  tags: []
95
- operationId: operationsDelete
96
94
  parameters:
97
95
  - $ref: "#/components/parameters/Operations_DeletePostFsParam"
98
96
  - $ref: "#/components/parameters/GlobalConfigParam"
@@ -106,12 +104,12 @@ paths:
106
104
  $ref: "#/components/responses/RcError"
107
105
  "5XX":
108
106
  $ref: "#/components/responses/RcError"
107
+ operationId: operationsDelete
109
108
  /operations/deletefile:
110
109
  post:
111
110
  summary: "Delete single file"
112
111
  description: "Removes a specific object from the remote."
113
112
  tags: []
114
- operationId: operationsDeletefile
115
113
  parameters:
116
114
  - $ref: "#/components/parameters/Operations_DeletefilePostFsParam"
117
115
  - $ref: "#/components/parameters/Operations_DeletefilePostRemoteParam"
@@ -124,12 +122,12 @@ paths:
124
122
  $ref: "#/components/responses/RcError"
125
123
  "5XX":
126
124
  $ref: "#/components/responses/RcError"
125
+ operationId: operationsDeletefile
127
126
  /operations/fsinfo:
128
127
  post:
129
128
  summary: "Describe remote capabilities"
130
129
  description: "Returns backend features, hash support, metadata descriptions, and other info for the remote."
131
130
  tags: []
132
- operationId: operationsFsinfo
133
131
  parameters:
134
132
  - $ref: "#/components/parameters/Operations_FsinfoPostFsParam"
135
133
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -141,12 +139,12 @@ paths:
141
139
  $ref: "#/components/responses/RcError"
142
140
  "5XX":
143
141
  $ref: "#/components/responses/RcError"
142
+ operationId: operationsFsinfo
144
143
  /operations/hashsum:
145
144
  post:
146
145
  summary: "Generate hash sums"
147
146
  description: "Produces a hash sum listing for files under the given path using the requested hash algorithm."
148
147
  tags: []
149
- operationId: operationsHashsum
150
148
  parameters:
151
149
  - $ref: "#/components/parameters/Operations_HashsumPostFsParam"
152
150
  - $ref: "#/components/parameters/Operations_HashsumPostHashTypeParam"
@@ -161,12 +159,12 @@ paths:
161
159
  $ref: "#/components/responses/RcError"
162
160
  "5XX":
163
161
  $ref: "#/components/responses/RcError"
162
+ operationId: operationsHashsum
164
163
  /operations/movefile:
165
164
  post:
166
165
  summary: "Move a single file"
167
166
  description: "Moves one object from a source remote and path to a destination remote and path."
168
167
  tags: []
169
- operationId: operationsMovefile
170
168
  parameters:
171
169
  - $ref: "#/components/parameters/Operations_MovefilePostSrcFsParam"
172
170
  - $ref: "#/components/parameters/Operations_MovefilePostSrcRemoteParam"
@@ -181,12 +179,12 @@ paths:
181
179
  $ref: "#/components/responses/RcError"
182
180
  "5XX":
183
181
  $ref: "#/components/responses/RcError"
182
+ operationId: operationsMovefile
184
183
  /operations/publiclink:
185
184
  post:
186
185
  summary: "Create or remove public link"
187
186
  description: "Creates a share URL for an object or removes an existing link when `unlink=true`."
188
187
  tags: []
189
- operationId: operationsPubliclink
190
188
  parameters:
191
189
  - $ref: "#/components/parameters/Operations_PubliclinkPostFsParam"
192
190
  - $ref: "#/components/parameters/Operations_PubliclinkPostRemoteParam"
@@ -201,12 +199,12 @@ paths:
201
199
  $ref: "#/components/responses/RcError"
202
200
  "5XX":
203
201
  $ref: "#/components/responses/RcError"
202
+ operationId: operationsPubliclink
204
203
  /operations/rmdirs:
205
204
  post:
206
205
  summary: "Remove empty directories"
207
206
  description: "Deletes empty subdirectories beneath the specified path, optionally leaving the root."
208
207
  tags: []
209
- operationId: operationsRmdirs
210
208
  parameters:
211
209
  - $ref: "#/components/parameters/Operations_RmdirsPostFsParam"
212
210
  - $ref: "#/components/parameters/Operations_RmdirsPostRemoteParam"
@@ -220,12 +218,12 @@ paths:
220
218
  $ref: "#/components/responses/RcError"
221
219
  "5XX":
222
220
  $ref: "#/components/responses/RcError"
221
+ operationId: operationsRmdirs
223
222
  /operations/settier:
224
223
  post:
225
224
  summary: "Change storage tier"
226
225
  description: "Updates the storage class or tier for every object in the specified remote path."
227
226
  tags: []
228
- operationId: operationsSettier
229
227
  parameters:
230
228
  - $ref: "#/components/parameters/Operations_SettierPostFsParam"
231
229
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -237,12 +235,12 @@ paths:
237
235
  $ref: "#/components/responses/RcError"
238
236
  "5XX":
239
237
  $ref: "#/components/responses/RcError"
238
+ operationId: operationsSettier
240
239
  /operations/settierfile:
241
240
  post:
242
241
  summary: "Change file storage tier"
243
242
  description: "Updates the storage class or tier for a single object."
244
243
  tags: []
245
- operationId: operationsSettierfile
246
244
  parameters:
247
245
  - $ref: "#/components/parameters/Operations_SettierfilePostFsParam"
248
246
  - $ref: "#/components/parameters/Operations_SettierfilePostRemoteParam"
@@ -255,12 +253,12 @@ paths:
255
253
  $ref: "#/components/responses/RcError"
256
254
  "5XX":
257
255
  $ref: "#/components/responses/RcError"
256
+ operationId: operationsSettierfile
258
257
  /operations/size:
259
258
  post:
260
259
  summary: "Count remote size"
261
260
  description: "Reports total size, file count, and number of objects without size metadata."
262
261
  tags: []
263
- operationId: operationsSize
264
262
  parameters:
265
263
  - $ref: "#/components/parameters/Operations_SizePostFsParam"
266
264
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -272,12 +270,12 @@ paths:
272
270
  $ref: "#/components/responses/RcError"
273
271
  "5XX":
274
272
  $ref: "#/components/responses/RcError"
273
+ operationId: operationsSize
275
274
  /core/bwlimit:
276
275
  post:
277
276
  summary: "Get or update bandwidth limits"
278
277
  description: "Reads the current bandwidth limit or applies a new schedule string, just like `rclone rc core/bwlimit`."
279
278
  tags: []
280
- operationId: coreBwlimit
281
279
  parameters:
282
280
  - $ref: "#/components/parameters/Core_BwlimitPostRateParam"
283
281
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -289,12 +287,12 @@ paths:
289
287
  $ref: "#/components/responses/RcError"
290
288
  "5XX":
291
289
  $ref: "#/components/responses/RcError"
290
+ operationId: coreBwlimit
292
291
  /core/command:
293
292
  post:
294
293
  summary: "Run an rclone command"
295
294
  description: "Executes a standard rclone CLI command remotely and streams or returns its output."
296
295
  tags: []
297
- operationId: coreCommand
298
296
  parameters:
299
297
  - $ref: "#/components/parameters/Core_CommandPostCommandParam"
300
298
  - $ref: "#/components/parameters/Core_CommandPostArgParam"
@@ -309,12 +307,12 @@ paths:
309
307
  $ref: "#/components/responses/RcError"
310
308
  "5XX":
311
309
  $ref: "#/components/responses/RcError"
310
+ operationId: coreCommand
312
311
  /core/du:
313
312
  post:
314
313
  summary: "Report disk usage"
315
314
  description: "Returns disk usage statistics for the supplied local directory (defaults to the cache dir)."
316
315
  tags: []
317
- operationId: coreDu
318
316
  parameters:
319
317
  - $ref: "#/components/parameters/Core_DuPostDirParam"
320
318
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -326,12 +324,12 @@ paths:
326
324
  $ref: "#/components/responses/RcError"
327
325
  "5XX":
328
326
  $ref: "#/components/responses/RcError"
327
+ operationId: coreDu
329
328
  /core/gc:
330
329
  post:
331
330
  summary: "Force garbage collection"
332
331
  description: "Triggers Go's garbage collector to release unused memory."
333
332
  tags: []
334
- operationId: coreGc
335
333
  parameters:
336
334
  - $ref: "#/components/parameters/GlobalGroupParam"
337
335
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -342,12 +340,12 @@ paths:
342
340
  $ref: "#/components/responses/RcError"
343
341
  "5XX":
344
342
  $ref: "#/components/responses/RcError"
343
+ operationId: coreGc
345
344
  /core/group-list:
346
345
  post:
347
346
  summary: "List stats groups"
348
347
  description: "Lists stats groups currently tracked by rclone."
349
348
  tags: []
350
- operationId: coreGroupList
351
349
  parameters:
352
350
  - $ref: "#/components/parameters/GlobalGroupParam"
353
351
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -369,12 +367,12 @@ paths:
369
367
  $ref: "#/components/responses/RcError"
370
368
  "5XX":
371
369
  $ref: "#/components/responses/RcError"
370
+ operationId: coreGroupList
372
371
  /core/memstats:
373
372
  post:
374
373
  summary: "Fetch runtime memory stats"
375
374
  description: "Returns Go runtime memory statistics similar to `runtime.ReadMemStats`."
376
375
  tags: []
377
- operationId: coreMemstats
378
376
  parameters:
379
377
  - $ref: "#/components/parameters/GlobalGroupParam"
380
378
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -391,12 +389,12 @@ paths:
391
389
  $ref: "#/components/responses/RcError"
392
390
  "5XX":
393
391
  $ref: "#/components/responses/RcError"
392
+ operationId: coreMemstats
394
393
  /core/obscure:
395
394
  post:
396
395
  summary: "Obscure a clear string"
397
396
  description: "Obscures a plain-text secret for inclusion in `rclone.conf`."
398
397
  tags: []
399
- operationId: coreObscure
400
398
  parameters:
401
399
  - $ref: "#/components/parameters/Core_ObscurePostClearParam"
402
400
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -417,12 +415,12 @@ paths:
417
415
  $ref: "#/components/responses/RcError"
418
416
  "5XX":
419
417
  $ref: "#/components/responses/RcError"
418
+ operationId: coreObscure
420
419
  /core/pid:
421
420
  post:
422
421
  summary: "Return rclone PID"
423
422
  description: "Returns the process ID of the running rclone instance."
424
423
  tags: []
425
- operationId: corePid
426
424
  parameters:
427
425
  - $ref: "#/components/parameters/GlobalGroupParam"
428
426
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -442,12 +440,12 @@ paths:
442
440
  $ref: "#/components/responses/RcError"
443
441
  "5XX":
444
442
  $ref: "#/components/responses/RcError"
443
+ operationId: corePid
445
444
  /core/quit:
446
445
  post:
447
446
  summary: "Terminate rclone"
448
447
  description: "Stops the rclone process, optionally supplying an exit code."
449
448
  tags: []
450
- operationId: coreQuit
451
449
  parameters:
452
450
  - $ref: "#/components/parameters/Core_QuitPostExitCodeParam"
453
451
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -459,12 +457,12 @@ paths:
459
457
  $ref: "#/components/responses/RcError"
460
458
  "5XX":
461
459
  $ref: "#/components/responses/RcError"
460
+ operationId: coreQuit
462
461
  /core/stats-delete:
463
462
  post:
464
463
  summary: "Delete stats group"
465
464
  description: "Deletes the counters associated with a specific stats group."
466
465
  tags: []
467
- operationId: coreStatsDelete
468
466
  parameters:
469
467
  - $ref: "#/components/parameters/Core_StatsDeletePostGroupParam"
470
468
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -476,12 +474,12 @@ paths:
476
474
  $ref: "#/components/responses/RcError"
477
475
  "5XX":
478
476
  $ref: "#/components/responses/RcError"
477
+ operationId: coreStatsDelete
479
478
  /core/stats-reset:
480
479
  post:
481
480
  summary: "Reset stats counters"
482
481
  description: "Clears counters, errors, and finished transfers for the provided stats group or all groups."
483
482
  tags: []
484
- operationId: coreStatsReset
485
483
  parameters:
486
484
  - $ref: "#/components/parameters/Core_StatsResetPostGroupParam"
487
485
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -493,12 +491,12 @@ paths:
493
491
  $ref: "#/components/responses/RcError"
494
492
  "5XX":
495
493
  $ref: "#/components/responses/RcError"
494
+ operationId: coreStatsReset
496
495
  /core/transferred:
497
496
  post:
498
497
  summary: "List completed transfers"
499
498
  description: "Returns up to 100 recently completed transfers for the requested stats group."
500
499
  tags: []
501
- operationId: coreTransferred
502
500
  parameters:
503
501
  - $ref: "#/components/parameters/Core_TransferredPostGroupParam"
504
502
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -510,10 +508,10 @@ paths:
510
508
  $ref: "#/components/responses/RcError"
511
509
  "5XX":
512
510
  $ref: "#/components/responses/RcError"
511
+ operationId: coreTransferred
513
512
  /debug/set-block-profile-rate:
514
513
  post:
515
514
  tags: []
516
- operationId: debugSetBlockProfileRate
517
515
  parameters:
518
516
  - $ref: "#/components/parameters/Debug_SetBlockProfileRatePostRateParam"
519
517
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -525,10 +523,10 @@ paths:
525
523
  $ref: "#/components/responses/RcError"
526
524
  "5XX":
527
525
  $ref: "#/components/responses/RcError"
526
+ operationId: debugSetBlockProfileRate
528
527
  /debug/set-gc-percent:
529
528
  post:
530
529
  tags: []
531
- operationId: debugSetGcPercent
532
530
  parameters:
533
531
  - $ref: "#/components/parameters/Debug_SetGcPercentPostGcPercentParam"
534
532
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -540,10 +538,10 @@ paths:
540
538
  $ref: "#/components/responses/RcError"
541
539
  "5XX":
542
540
  $ref: "#/components/responses/RcError"
541
+ operationId: debugSetGcPercent
543
542
  /debug/set-mutex-profile-fraction:
544
543
  post:
545
544
  tags: []
546
- operationId: debugSetMutexProfileFraction
547
545
  parameters:
548
546
  - $ref: "#/components/parameters/Debug_SetMutexProfileFractionPostRateParam"
549
547
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -555,10 +553,10 @@ paths:
555
553
  $ref: "#/components/responses/RcError"
556
554
  "5XX":
557
555
  $ref: "#/components/responses/RcError"
556
+ operationId: debugSetMutexProfileFraction
558
557
  /debug/set-soft-memory-limit:
559
558
  post:
560
559
  tags: []
561
- operationId: debugSetSoftMemoryLimit
562
560
  parameters:
563
561
  - $ref: "#/components/parameters/Debug_SetSoftMemoryLimitPostMemLimitParam"
564
562
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -570,10 +568,10 @@ paths:
570
568
  $ref: "#/components/responses/RcError"
571
569
  "5XX":
572
570
  $ref: "#/components/responses/RcError"
571
+ operationId: debugSetSoftMemoryLimit
573
572
  /fscache/clear:
574
573
  post:
575
574
  tags: []
576
- operationId: fscacheClear
577
575
  parameters:
578
576
  - $ref: "#/components/parameters/GlobalGroupParam"
579
577
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -584,10 +582,10 @@ paths:
584
582
  $ref: "#/components/responses/RcError"
585
583
  "5XX":
586
584
  $ref: "#/components/responses/RcError"
585
+ operationId: fscacheClear
587
586
  /fscache/entries:
588
587
  post:
589
588
  tags: []
590
- operationId: fscacheEntries
591
589
  parameters:
592
590
  - $ref: "#/components/parameters/GlobalGroupParam"
593
591
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -598,10 +596,10 @@ paths:
598
596
  $ref: "#/components/responses/RcError"
599
597
  "5XX":
600
598
  $ref: "#/components/responses/RcError"
599
+ operationId: fscacheEntries
601
600
  /mount/listmounts:
602
601
  post:
603
602
  tags: []
604
- operationId: mountListmounts
605
603
  parameters:
606
604
  - $ref: "#/components/parameters/GlobalGroupParam"
607
605
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -612,10 +610,10 @@ paths:
612
610
  $ref: "#/components/responses/RcError"
613
611
  "5XX":
614
612
  $ref: "#/components/responses/RcError"
613
+ operationId: mountListmounts
615
614
  /mount/mount:
616
615
  post:
617
616
  tags: []
618
- operationId: mountMount
619
617
  parameters:
620
618
  - $ref: "#/components/parameters/Mount_MountPostFsParam"
621
619
  - $ref: "#/components/parameters/Mount_MountPostMountPointParam"
@@ -633,10 +631,10 @@ paths:
633
631
  $ref: "#/components/responses/RcError"
634
632
  "5XX":
635
633
  $ref: "#/components/responses/RcError"
634
+ operationId: mountMount
636
635
  /mount/types:
637
636
  post:
638
637
  tags: []
639
- operationId: mountTypes
640
638
  parameters:
641
639
  - $ref: "#/components/parameters/GlobalGroupParam"
642
640
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -647,10 +645,10 @@ paths:
647
645
  $ref: "#/components/responses/RcError"
648
646
  "5XX":
649
647
  $ref: "#/components/responses/RcError"
648
+ operationId: mountTypes
650
649
  /mount/unmount:
651
650
  post:
652
651
  tags: []
653
- operationId: mountUnmount
654
652
  parameters:
655
653
  - $ref: "#/components/parameters/Mount_UnmountPostMountPointParam"
656
654
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -662,10 +660,10 @@ paths:
662
660
  $ref: "#/components/responses/RcError"
663
661
  "5XX":
664
662
  $ref: "#/components/responses/RcError"
663
+ operationId: mountUnmount
665
664
  /mount/unmountall:
666
665
  post:
667
666
  tags: []
668
- operationId: mountUnmountall
669
667
  parameters:
670
668
  - $ref: "#/components/parameters/GlobalGroupParam"
671
669
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -676,12 +674,12 @@ paths:
676
674
  $ref: "#/components/responses/RcError"
677
675
  "5XX":
678
676
  $ref: "#/components/responses/RcError"
677
+ operationId: mountUnmountall
679
678
  /rc/noopauth:
680
679
  post:
681
680
  summary: "Echo parameters (auth required)"
682
681
  description: "Same as `rc/noop`, but requires authentication to validate access control."
683
682
  tags: []
684
- operationId: rcNoopAuth
685
683
  parameters:
686
684
  - $ref: "#/components/parameters/Rc_NoopauthPostAdditionalParam"
687
685
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -692,12 +690,12 @@ paths:
692
690
  $ref: "#/components/responses/RcError"
693
691
  "5XX":
694
692
  $ref: "#/components/responses/RcError"
693
+ operationId: rcNoopAuth
695
694
  /rc/error:
696
695
  post:
697
696
  summary: "Return a test error"
698
697
  description: "Always returns an error response incorporating the supplied parameters, useful for testing error handling."
699
698
  tags: []
700
- operationId: rcError
701
699
  parameters:
702
700
  - $ref: "#/components/parameters/Rc_ErrorPostAdditionalParam"
703
701
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -708,12 +706,12 @@ paths:
708
706
  $ref: "#/components/responses/RcError"
709
707
  "5XX":
710
708
  $ref: "#/components/responses/RcError"
709
+ operationId: rcError
711
710
  /rc/list:
712
711
  post:
713
712
  summary: "List RC commands"
714
713
  description: "Returns metadata about every available RC command, including whether authentication is required."
715
714
  tags: []
716
- operationId: rcList
717
715
  parameters:
718
716
  - $ref: "#/components/parameters/GlobalGroupParam"
719
717
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -724,12 +722,12 @@ paths:
724
722
  $ref: "#/components/responses/RcError"
725
723
  "5XX":
726
724
  $ref: "#/components/responses/RcError"
725
+ operationId: rcList
727
726
  /backend/command:
728
727
  post:
729
728
  summary: "Run backend command"
730
729
  description: "Invokes a backend-specific management command against an optional remote."
731
730
  tags: []
732
- operationId: backendCommand
733
731
  parameters:
734
732
  - $ref: "#/components/parameters/Backend_CommandPostCommandParam"
735
733
  - $ref: "#/components/parameters/Backend_CommandPostFsParam"
@@ -744,12 +742,12 @@ paths:
744
742
  $ref: "#/components/responses/RcError"
745
743
  "5XX":
746
744
  $ref: "#/components/responses/RcError"
745
+ operationId: backendCommand
747
746
  /cache/expire:
748
747
  post:
749
748
  summary: "Expire cache entries"
750
749
  description: "Drops cached directory entries, and optionally cached file data, for the cache backend."
751
750
  tags: []
752
- operationId: cacheExpire
753
751
  parameters:
754
752
  - $ref: "#/components/parameters/Cache_ExpirePostRemoteParam"
755
753
  - $ref: "#/components/parameters/Cache_ExpirePostWithDataParam"
@@ -762,12 +760,12 @@ paths:
762
760
  $ref: "#/components/responses/RcError"
763
761
  "5XX":
764
762
  $ref: "#/components/responses/RcError"
763
+ operationId: cacheExpire
765
764
  /cache/fetch:
766
765
  post:
767
766
  summary: "Prefetch cache chunks"
768
767
  description: "Ensures specified file chunks are cached locally for a cache remote."
769
768
  tags: []
770
- operationId: cacheFetch
771
769
  parameters:
772
770
  - $ref: "#/components/parameters/Cache_FetchPostChunksParam"
773
771
  - $ref: "#/components/parameters/Cache_FetchPostAdditionalParam"
@@ -780,12 +778,12 @@ paths:
780
778
  $ref: "#/components/responses/RcError"
781
779
  "5XX":
782
780
  $ref: "#/components/responses/RcError"
781
+ operationId: cacheFetch
783
782
  /cache/stats:
784
783
  post:
785
784
  summary: "Show cache stats"
786
785
  description: "Returns runtime statistics for the cache backend."
787
786
  tags: []
788
- operationId: cacheStats
789
787
  parameters:
790
788
  - $ref: "#/components/parameters/GlobalGroupParam"
791
789
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -796,12 +794,12 @@ paths:
796
794
  $ref: "#/components/responses/RcError"
797
795
  "5XX":
798
796
  $ref: "#/components/responses/RcError"
797
+ operationId: cacheStats
799
798
  /config/create:
800
799
  post:
801
800
  summary: "Create remote configuration"
802
801
  description: "Creates a new remote in `rclone.conf`, mirroring `rclone config create`."
803
802
  tags: []
804
- operationId: configCreate
805
803
  parameters:
806
804
  - $ref: "#/components/parameters/Config_CreatePostNameParam"
807
805
  - $ref: "#/components/parameters/Config_CreatePostParametersParam"
@@ -816,12 +814,12 @@ paths:
816
814
  $ref: "#/components/responses/RcError"
817
815
  "5XX":
818
816
  $ref: "#/components/responses/RcError"
817
+ operationId: configCreate
819
818
  /config/delete:
820
819
  post:
821
820
  summary: "Delete remote configuration"
822
821
  description: "Removes an existing remote from `rclone.conf`."
823
822
  tags: []
824
- operationId: configDelete
825
823
  parameters:
826
824
  - $ref: "#/components/parameters/Config_DeletePostNameParam"
827
825
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -833,12 +831,12 @@ paths:
833
831
  $ref: "#/components/responses/RcError"
834
832
  "5XX":
835
833
  $ref: "#/components/responses/RcError"
834
+ operationId: configDelete
836
835
  /config/dump:
837
836
  post:
838
837
  summary: "Dump configuration"
839
838
  description: "Returns the contents of the config file as a JSON object keyed by remote name."
840
839
  tags: []
841
- operationId: configDump
842
840
  parameters:
843
841
  - $ref: "#/components/parameters/GlobalGroupParam"
844
842
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -849,12 +847,12 @@ paths:
849
847
  $ref: "#/components/responses/RcError"
850
848
  "5XX":
851
849
  $ref: "#/components/responses/RcError"
850
+ operationId: configDump
852
851
  /config/get:
853
852
  post:
854
853
  summary: "Get remote configuration"
855
854
  description: "Returns the key/value settings for a single remote."
856
855
  tags: []
857
- operationId: configGet
858
856
  parameters:
859
857
  - $ref: "#/components/parameters/Config_GetPostNameParam"
860
858
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -866,12 +864,12 @@ paths:
866
864
  $ref: "#/components/responses/RcError"
867
865
  "5XX":
868
866
  $ref: "#/components/responses/RcError"
867
+ operationId: configGet
869
868
  /config/listremotes:
870
869
  post:
871
870
  summary: "List configured remotes"
872
871
  description: "Returns the names of all remotes defined in the config file."
873
872
  tags: []
874
- operationId: configListremotes
875
873
  parameters:
876
874
  - $ref: "#/components/parameters/GlobalGroupParam"
877
875
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -882,12 +880,12 @@ paths:
882
880
  $ref: "#/components/responses/RcError"
883
881
  "5XX":
884
882
  $ref: "#/components/responses/RcError"
883
+ operationId: configListremotes
885
884
  /config/password:
886
885
  post:
887
886
  summary: "Update remote secrets"
888
887
  description: "Sets obscured password fields for a remote configuration."
889
888
  tags: []
890
- operationId: configPassword
891
889
  parameters:
892
890
  - $ref: "#/components/parameters/Config_PasswordPostNameParam"
893
891
  - $ref: "#/components/parameters/Config_PasswordPostParametersParam"
@@ -900,12 +898,12 @@ paths:
900
898
  $ref: "#/components/responses/RcError"
901
899
  "5XX":
902
900
  $ref: "#/components/responses/RcError"
901
+ operationId: configPassword
903
902
  /config/paths:
904
903
  post:
905
904
  summary: "Show config paths"
906
905
  description: "Returns the paths to the config file, cache directory, and temporary directory."
907
906
  tags: []
908
- operationId: configPaths
909
907
  parameters:
910
908
  - $ref: "#/components/parameters/GlobalGroupParam"
911
909
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -916,12 +914,12 @@ paths:
916
914
  $ref: "#/components/responses/RcError"
917
915
  "5XX":
918
916
  $ref: "#/components/responses/RcError"
917
+ operationId: configPaths
919
918
  /config/providers:
920
919
  post:
921
920
  summary: "List backend providers"
922
921
  description: "Returns metadata describing each supported storage provider."
923
922
  tags: []
924
- operationId: configProviders
925
923
  parameters:
926
924
  - $ref: "#/components/parameters/GlobalGroupParam"
927
925
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -932,12 +930,12 @@ paths:
932
930
  $ref: "#/components/responses/RcError"
933
931
  "5XX":
934
932
  $ref: "#/components/responses/RcError"
933
+ operationId: configProviders
935
934
  /config/setpath:
936
935
  post:
937
936
  summary: "Set config path"
938
937
  description: "Points rclone at a specific `rclone.conf` file."
939
938
  tags: []
940
- operationId: configSetpath
941
939
  parameters:
942
940
  - $ref: "#/components/parameters/Config_SetpathPostPathParam"
943
941
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -949,12 +947,12 @@ paths:
949
947
  $ref: "#/components/responses/RcError"
950
948
  "5XX":
951
949
  $ref: "#/components/responses/RcError"
950
+ operationId: configSetpath
952
951
  /config/unlock:
953
952
  post:
954
953
  summary: "Unlock encrypted config"
955
954
  description: "Unlocks the configuration file using the provided password."
956
955
  tags: []
957
- operationId: configUnlock
958
956
  parameters:
959
957
  - $ref: "#/components/parameters/Config_UnlockPostConfigPasswordParam"
960
958
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -966,12 +964,12 @@ paths:
966
964
  $ref: "#/components/responses/RcError"
967
965
  "5XX":
968
966
  $ref: "#/components/responses/RcError"
967
+ operationId: configUnlock
969
968
  /config/update:
970
969
  post:
971
970
  summary: "Update remote configuration"
972
971
  description: "Updates an existing remote with new parameter values."
973
972
  tags: []
974
- operationId: configUpdate
975
973
  parameters:
976
974
  - $ref: "#/components/parameters/Config_UpdatePostNameParam"
977
975
  - $ref: "#/components/parameters/Config_UpdatePostParametersParam"
@@ -985,12 +983,12 @@ paths:
985
983
  $ref: "#/components/responses/RcError"
986
984
  "5XX":
987
985
  $ref: "#/components/responses/RcError"
986
+ operationId: configUpdate
988
987
  /core/version:
989
988
  post:
990
989
  summary: "Report rclone version"
991
990
  description: "Returns the running rclone version, build metadata, and Go runtime details."
992
991
  tags: []
993
- operationId: coreVersion
994
992
  parameters:
995
993
  - $ref: "#/components/parameters/GlobalGroupParam"
996
994
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1001,12 +999,12 @@ paths:
1001
999
  $ref: "#/components/responses/RcError"
1002
1000
  "5XX":
1003
1001
  $ref: "#/components/responses/RcError"
1002
+ operationId: coreVersion
1004
1003
  /core/stats:
1005
1004
  post:
1006
1005
  summary: "Current stats snapshot"
1007
1006
  description: "Returns active transfer statistics including bytes transferred, speed, and error counts."
1008
1007
  tags: []
1009
- operationId: coreStats
1010
1008
  parameters:
1011
1009
  - $ref: "#/components/parameters/Core_StatsPostGroupParam"
1012
1010
  - $ref: "#/components/parameters/Core_StatsPostShortParam"
@@ -1019,12 +1017,12 @@ paths:
1019
1017
  $ref: "#/components/responses/RcError"
1020
1018
  "5XX":
1021
1019
  $ref: "#/components/responses/RcError"
1020
+ operationId: coreStats
1022
1021
  /job/list:
1023
1022
  post:
1024
1023
  summary: "List jobs"
1025
1024
  description: "Returns identifiers of active and recently completed asynchronous jobs."
1026
1025
  tags: []
1027
- operationId: jobList
1028
1026
  parameters:
1029
1027
  - $ref: "#/components/parameters/GlobalAsyncParam"
1030
1028
  responses:
@@ -1034,12 +1032,12 @@ paths:
1034
1032
  $ref: "#/components/responses/RcError"
1035
1033
  "5XX":
1036
1034
  $ref: "#/components/responses/RcError"
1035
+ operationId: jobList
1037
1036
  /job/status:
1038
1037
  post:
1039
1038
  summary: "Get job status"
1040
1039
  description: "Returns timing, success state, output, and progress for a specific job."
1041
1040
  tags: []
1042
- operationId: jobStatus
1043
1041
  parameters:
1044
1042
  - $ref: "#/components/parameters/Job_StatusPostJobidParam"
1045
1043
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1050,12 +1048,12 @@ paths:
1050
1048
  $ref: "#/components/responses/RcError"
1051
1049
  "5XX":
1052
1050
  $ref: "#/components/responses/RcError"
1051
+ operationId: jobStatus
1053
1052
  /job/stop:
1054
1053
  post:
1055
1054
  summary: "Stop job"
1056
1055
  description: "Attempts to cancel a running job by ID."
1057
1056
  tags: []
1058
- operationId: jobStop
1059
1057
  parameters:
1060
1058
  - $ref: "#/components/parameters/Job_StopPostJobidParam"
1061
1059
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1066,12 +1064,12 @@ paths:
1066
1064
  $ref: "#/components/responses/RcError"
1067
1065
  "5XX":
1068
1066
  $ref: "#/components/responses/RcError"
1067
+ operationId: jobStop
1069
1068
  /job/stopgroup:
1070
1069
  post:
1071
1070
  summary: "Stop jobs in group"
1072
1071
  description: "Cancels all active jobs associated with the provided stats group."
1073
1072
  tags: []
1074
- operationId: jobStopgroup
1075
1073
  parameters:
1076
1074
  - $ref: "#/components/parameters/Job_StopgroupPostGroupParam"
1077
1075
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1082,12 +1080,12 @@ paths:
1082
1080
  $ref: "#/components/responses/RcError"
1083
1081
  "5XX":
1084
1082
  $ref: "#/components/responses/RcError"
1083
+ operationId: jobStopgroup
1085
1084
  /operations/list:
1086
1085
  post:
1087
1086
  summary: "List objects"
1088
1087
  description: "Lists objects and directories for a remote path, returning the same fields as `rclone lsjson`."
1089
1088
  tags: []
1090
- operationId: operationsList
1091
1089
  parameters:
1092
1090
  - $ref: "#/components/parameters/Operations_ListPostFsParam"
1093
1091
  - $ref: "#/components/parameters/Operations_ListPostRemoteParam"
@@ -1111,12 +1109,12 @@ paths:
1111
1109
  $ref: "#/components/responses/RcError"
1112
1110
  "5XX":
1113
1111
  $ref: "#/components/responses/RcError"
1112
+ operationId: operationsList
1114
1113
  /operations/stat:
1115
1114
  post:
1116
1115
  summary: "Stat an object"
1117
1116
  description: "Returns metadata for a single file or directory, mirroring `rclone lsjson` on one entry."
1118
1117
  tags: []
1119
- operationId: operationsStat
1120
1118
  parameters:
1121
1119
  - $ref: "#/components/parameters/Operations_StatPostFsParam"
1122
1120
  - $ref: "#/components/parameters/Operations_StatPostRemoteParam"
@@ -1130,12 +1128,12 @@ paths:
1130
1128
  $ref: "#/components/responses/RcError"
1131
1129
  "5XX":
1132
1130
  $ref: "#/components/responses/RcError"
1131
+ operationId: operationsStat
1133
1132
  /operations/about:
1134
1133
  post:
1135
1134
  summary: "Get remote quota"
1136
1135
  description: "Returns storage quota and usage details for the remote, equivalent to `rclone about`."
1137
1136
  tags: []
1138
- operationId: operationsAbout
1139
1137
  parameters:
1140
1138
  - $ref: "#/components/parameters/Operations_AboutPostFsParam"
1141
1139
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1147,12 +1145,12 @@ paths:
1147
1145
  $ref: "#/components/responses/RcError"
1148
1146
  "5XX":
1149
1147
  $ref: "#/components/responses/RcError"
1148
+ operationId: operationsAbout
1150
1149
  /operations/uploadfile:
1151
1150
  post:
1152
1151
  summary: "Upload files via multipart"
1153
1152
  description: "Accepts multipart/form-data payloads and writes the uploaded files to the specified remote path."
1154
1153
  tags: []
1155
- operationId: operationsUploadfile
1156
1154
  parameters:
1157
1155
  - $ref: "#/components/parameters/Operations_UploadfilePostFsParam"
1158
1156
  - $ref: "#/components/parameters/Operations_UploadfilePostRemoteParam"
@@ -1171,12 +1169,12 @@ paths:
1171
1169
  $ref: "#/components/responses/RcError"
1172
1170
  "5XX":
1173
1171
  $ref: "#/components/responses/RcError"
1172
+ operationId: operationsUploadfile
1174
1173
  /operations/purge:
1175
1174
  post:
1176
1175
  summary: "Purge directory"
1177
1176
  description: "Deletes a directory or container and all of its contents."
1178
1177
  tags: []
1179
- operationId: operationsPurge
1180
1178
  parameters:
1181
1179
  - $ref: "#/components/parameters/Operations_PurgePostFsParam"
1182
1180
  - $ref: "#/components/parameters/Operations_PurgePostRemoteParam"
@@ -1191,12 +1189,12 @@ paths:
1191
1189
  $ref: "#/components/responses/RcError"
1192
1190
  "5XX":
1193
1191
  $ref: "#/components/responses/RcError"
1192
+ operationId: operationsPurge
1194
1193
  /operations/mkdir:
1195
1194
  post:
1196
1195
  summary: "Create directory"
1197
1196
  description: "Creates the target directory or container if it does not exist."
1198
1197
  tags: []
1199
- operationId: operationsMkdir
1200
1198
  parameters:
1201
1199
  - $ref: "#/components/parameters/Operations_MkdirPostFsParam"
1202
1200
  - $ref: "#/components/parameters/Operations_MkdirPostRemoteParam"
@@ -1209,12 +1207,12 @@ paths:
1209
1207
  $ref: "#/components/responses/RcError"
1210
1208
  "5XX":
1211
1209
  $ref: "#/components/responses/RcError"
1210
+ operationId: operationsMkdir
1212
1211
  /operations/rmdir:
1213
1212
  post:
1214
1213
  summary: "Remove empty directory"
1215
1214
  description: "Deletes an empty directory or container."
1216
1215
  tags: []
1217
- operationId: operationsRmdir
1218
1216
  parameters:
1219
1217
  - $ref: "#/components/parameters/Operations_RmdirPostFsParam"
1220
1218
  - $ref: "#/components/parameters/Operations_RmdirPostRemoteParam"
@@ -1227,12 +1225,12 @@ paths:
1227
1225
  $ref: "#/components/responses/RcError"
1228
1226
  "5XX":
1229
1227
  $ref: "#/components/responses/RcError"
1228
+ operationId: operationsRmdir
1230
1229
  /operations/check:
1231
1230
  post:
1232
1231
  summary: "Compare source and destination"
1233
1232
  description: "Compares source and destination trees, reporting matches, differences, and missing files."
1234
1233
  tags: []
1235
- operationId: operationsCheck
1236
1234
  parameters:
1237
1235
  - $ref: "#/components/parameters/Operations_CheckPostSrcFsParam"
1238
1236
  - $ref: "#/components/parameters/Operations_CheckPostDstFsParam"
@@ -1256,12 +1254,12 @@ paths:
1256
1254
  $ref: "#/components/responses/RcError"
1257
1255
  "5XX":
1258
1256
  $ref: "#/components/responses/RcError"
1257
+ operationId: operationsCheck
1259
1258
  /sync/sync:
1260
1259
  post:
1261
1260
  summary: "Sync source to destination"
1262
1261
  description: "Synchronises a source remote to a destination remote, making the destination match the source."
1263
1262
  tags: []
1264
- operationId: syncSync
1265
1263
  parameters:
1266
1264
  - $ref: "#/components/parameters/Sync_SyncPostSrcFsParam"
1267
1265
  - $ref: "#/components/parameters/Sync_SyncPostDstFsParam"
@@ -1277,12 +1275,12 @@ paths:
1277
1275
  $ref: "#/components/responses/RcError"
1278
1276
  "5XX":
1279
1277
  $ref: "#/components/responses/RcError"
1278
+ operationId: syncSync
1280
1279
  /sync/copy:
1281
1280
  post:
1282
1281
  summary: "Copy source to destination"
1283
1282
  description: "Copies objects from a source remote to a destination remote without deleting destination files."
1284
1283
  tags: []
1285
- operationId: syncCopy
1286
1284
  parameters:
1287
1285
  - $ref: "#/components/parameters/Sync_CopyPostSrcFsParam"
1288
1286
  - $ref: "#/components/parameters/Sync_CopyPostDstFsParam"
@@ -1298,12 +1296,12 @@ paths:
1298
1296
  $ref: "#/components/responses/RcError"
1299
1297
  "5XX":
1300
1298
  $ref: "#/components/responses/RcError"
1299
+ operationId: syncCopy
1301
1300
  /sync/move:
1302
1301
  post:
1303
1302
  summary: "Move source to destination"
1304
1303
  description: "Moves objects from a source remote to a destination remote, optionally cleaning up empty directories."
1305
1304
  tags: []
1306
- operationId: syncMove
1307
1305
  parameters:
1308
1306
  - $ref: "#/components/parameters/Sync_MovePostSrcFsParam"
1309
1307
  - $ref: "#/components/parameters/Sync_MovePostDstFsParam"
@@ -1320,12 +1318,12 @@ paths:
1320
1318
  $ref: "#/components/responses/RcError"
1321
1319
  "5XX":
1322
1320
  $ref: "#/components/responses/RcError"
1321
+ operationId: syncMove
1323
1322
  /sync/bisync:
1324
1323
  post:
1325
1324
  summary: "Bidirectional sync"
1326
1325
  description: "Performs a bidirectional synchronisation between two paths, supporting safety checks and recovery options."
1327
1326
  tags: []
1328
- operationId: syncBisync
1329
1327
  parameters:
1330
1328
  - $ref: "#/components/parameters/Sync_BisyncPostPath1Param"
1331
1329
  - $ref: "#/components/parameters/Sync_BisyncPostPath2Param"
@@ -1356,12 +1354,12 @@ paths:
1356
1354
  $ref: "#/components/responses/RcError"
1357
1355
  "5XX":
1358
1356
  $ref: "#/components/responses/RcError"
1357
+ operationId: syncBisync
1359
1358
  /options/blocks:
1360
1359
  post:
1361
1360
  summary: "List option blocks"
1362
1361
  description: "Returns the names of option blocks that can be queried or updated."
1363
1362
  tags: []
1364
- operationId: optionsBlocks
1365
1363
  parameters:
1366
1364
  - $ref: "#/components/parameters/GlobalGroupParam"
1367
1365
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1372,12 +1370,12 @@ paths:
1372
1370
  $ref: "#/components/responses/RcError"
1373
1371
  "5XX":
1374
1372
  $ref: "#/components/responses/RcError"
1373
+ operationId: optionsBlocks
1375
1374
  /options/get:
1376
1375
  post:
1377
1376
  summary: "Get option values"
1378
1377
  description: "Returns the current global option values, optionally filtered by block."
1379
1378
  tags: []
1380
- operationId: optionsGet
1381
1379
  parameters:
1382
1380
  - $ref: "#/components/parameters/Options_GetPostBlocksParam"
1383
1381
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1389,12 +1387,12 @@ paths:
1389
1387
  $ref: "#/components/responses/RcError"
1390
1388
  "5XX":
1391
1389
  $ref: "#/components/responses/RcError"
1390
+ operationId: optionsGet
1392
1391
  /options/info:
1393
1392
  post:
1394
1393
  summary: "Describe options"
1395
1394
  description: "Returns metadata for options, including help text and defaults, grouped by block."
1396
1395
  tags: []
1397
- operationId: optionsInfo
1398
1396
  parameters:
1399
1397
  - $ref: "#/components/parameters/Options_InfoPostBlocksParam"
1400
1398
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1406,16 +1404,13 @@ paths:
1406
1404
  $ref: "#/components/responses/RcError"
1407
1405
  "5XX":
1408
1406
  $ref: "#/components/responses/RcError"
1407
+ operationId: optionsInfo
1409
1408
  /options/set:
1410
1409
  post:
1411
1410
  summary: "Set option values"
1412
1411
  description: >
1413
- Sets temporary option overrides for the running process by supplying key/value
1414
- pairs grouped under option block names. Provide one or more query parameters
1415
- whose names match the blocks you want to modify (for example `main`, `rc`,
1416
- `http`). Each block parameter carries an object of option overrides.
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.
1417
1413
  tags: []
1418
- operationId: optionsSet
1419
1414
  x-additionalQueryBlocksAllowed: true
1420
1415
  parameters:
1421
1416
  - $ref: "#/components/parameters/Options_SetPostDlnaParam"
@@ -1442,12 +1437,12 @@ paths:
1442
1437
  $ref: "#/components/responses/RcError"
1443
1438
  "5XX":
1444
1439
  $ref: "#/components/responses/RcError"
1440
+ operationId: optionsSet
1445
1441
  /options/local:
1446
1442
  post:
1447
1443
  summary: "Show effective options"
1448
1444
  description: "Returns the current effective options for this request, including `_config` and `_filter` overrides."
1449
1445
  tags: []
1450
- operationId: optionsLocal
1451
1446
  parameters:
1452
1447
  - $ref: "#/components/parameters/GlobalGroupParam"
1453
1448
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1458,12 +1453,12 @@ paths:
1458
1453
  $ref: "#/components/responses/RcError"
1459
1454
  "5XX":
1460
1455
  $ref: "#/components/responses/RcError"
1456
+ operationId: optionsLocal
1461
1457
  /serve/list:
1462
1458
  post:
1463
1459
  summary: "List serve instances"
1464
1460
  description: "Returns all running `rclone serve` instances with their IDs and options."
1465
1461
  tags: []
1466
- operationId: serveList
1467
1462
  parameters:
1468
1463
  - $ref: "#/components/parameters/GlobalGroupParam"
1469
1464
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1474,12 +1469,12 @@ paths:
1474
1469
  $ref: "#/components/responses/RcError"
1475
1470
  "5XX":
1476
1471
  $ref: "#/components/responses/RcError"
1472
+ operationId: serveList
1477
1473
  /serve/start:
1478
1474
  post:
1479
1475
  summary: "Start serve instance"
1480
1476
  description: "Launches a new `rclone serve` endpoint (http, webdav, ftp, etc.) with the provided parameters."
1481
1477
  tags: []
1482
- operationId: serveStart
1483
1478
  parameters:
1484
1479
  - $ref: "#/components/parameters/Serve_StartPostTypeParam"
1485
1480
  - $ref: "#/components/parameters/Serve_StartPostFsParam"
@@ -1496,12 +1491,12 @@ paths:
1496
1491
  $ref: "#/components/responses/RcError"
1497
1492
  "5XX":
1498
1493
  $ref: "#/components/responses/RcError"
1494
+ operationId: serveStart
1499
1495
  /serve/stop:
1500
1496
  post:
1501
1497
  summary: "Stop serve instance"
1502
1498
  description: "Stops a running `serve` instance identified by its ID."
1503
1499
  tags: []
1504
- operationId: serveStop
1505
1500
  parameters:
1506
1501
  - $ref: "#/components/parameters/Serve_StopPostIdParam"
1507
1502
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1513,12 +1508,12 @@ paths:
1513
1508
  $ref: "#/components/responses/RcError"
1514
1509
  "5XX":
1515
1510
  $ref: "#/components/responses/RcError"
1511
+ operationId: serveStop
1516
1512
  /serve/stopall:
1517
1513
  post:
1518
1514
  summary: "Stop all serve instances"
1519
1515
  description: "Stops every active `serve` instance."
1520
1516
  tags: []
1521
- operationId: serveStopall
1522
1517
  parameters:
1523
1518
  - $ref: "#/components/parameters/GlobalGroupParam"
1524
1519
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1529,12 +1524,12 @@ paths:
1529
1524
  $ref: "#/components/responses/RcError"
1530
1525
  "5XX":
1531
1526
  $ref: "#/components/responses/RcError"
1527
+ operationId: serveStopall
1532
1528
  /serve/types:
1533
1529
  post:
1534
1530
  summary: "List serve types"
1535
1531
  description: "Returns the list of supported `rclone serve` protocols."
1536
1532
  tags: []
1537
- operationId: serveTypes
1538
1533
  parameters:
1539
1534
  - $ref: "#/components/parameters/GlobalGroupParam"
1540
1535
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1545,12 +1540,12 @@ paths:
1545
1540
  $ref: "#/components/responses/RcError"
1546
1541
  "5XX":
1547
1542
  $ref: "#/components/responses/RcError"
1543
+ operationId: serveTypes
1548
1544
  /vfs/forget:
1549
1545
  post:
1550
1546
  summary: "Forget cached paths"
1551
1547
  description: "Evicts specific files or directories from the VFS directory cache."
1552
1548
  tags: []
1553
- operationId: vfsForget
1554
1549
  parameters:
1555
1550
  - $ref: "#/components/parameters/Vfs_ForgetPostFsParam"
1556
1551
  - $ref: "#/components/parameters/Vfs_ForgetPostAdditionalParam"
@@ -1563,12 +1558,12 @@ paths:
1563
1558
  $ref: "#/components/responses/RcError"
1564
1559
  "5XX":
1565
1560
  $ref: "#/components/responses/RcError"
1561
+ operationId: vfsForget
1566
1562
  /vfs/list:
1567
1563
  post:
1568
1564
  summary: "List VFS instances"
1569
1565
  description: "Lists the active VFS instances and their identifiers."
1570
1566
  tags: []
1571
- operationId: vfsList
1572
1567
  parameters:
1573
1568
  - $ref: "#/components/parameters/Vfs_ListPostFsParam"
1574
1569
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1580,12 +1575,12 @@ paths:
1580
1575
  $ref: "#/components/responses/RcError"
1581
1576
  "5XX":
1582
1577
  $ref: "#/components/responses/RcError"
1578
+ operationId: vfsList
1583
1579
  /vfs/poll-interval:
1584
1580
  post:
1585
1581
  summary: "Get or set poll interval"
1586
1582
  description: "Reads or updates the VFS poll interval duration, optionally waiting for the change to apply."
1587
1583
  tags: []
1588
- operationId: vfsPollInterval
1589
1584
  parameters:
1590
1585
  - $ref: "#/components/parameters/Vfs_PollIntervalPostFsParam"
1591
1586
  - $ref: "#/components/parameters/Vfs_PollIntervalPostIntervalParam"
@@ -1599,12 +1594,12 @@ paths:
1599
1594
  $ref: "#/components/responses/RcError"
1600
1595
  "5XX":
1601
1596
  $ref: "#/components/responses/RcError"
1597
+ operationId: vfsPollInterval
1602
1598
  /vfs/queue:
1603
1599
  post:
1604
1600
  summary: "Inspect upload queue"
1605
1601
  description: "Returns the contents of the VFS upload queue."
1606
1602
  tags: []
1607
- operationId: vfsQueue
1608
1603
  parameters:
1609
1604
  - $ref: "#/components/parameters/Vfs_QueuePostFsParam"
1610
1605
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1616,12 +1611,12 @@ paths:
1616
1611
  $ref: "#/components/responses/RcError"
1617
1612
  "5XX":
1618
1613
  $ref: "#/components/responses/RcError"
1614
+ operationId: vfsQueue
1619
1615
  /vfs/queue-set-expiry:
1620
1616
  post:
1621
1617
  summary: "Adjust queue expiry"
1622
1618
  description: "Sets the expiry time of a queued VFS upload item, optionally relative to its current value."
1623
1619
  tags: []
1624
- operationId: vfsQueueSetExpiry
1625
1620
  parameters:
1626
1621
  - $ref: "#/components/parameters/Vfs_QueueSetExpiryPostFsParam"
1627
1622
  - $ref: "#/components/parameters/Vfs_QueueSetExpiryPostIdParam"
@@ -1636,12 +1631,12 @@ paths:
1636
1631
  $ref: "#/components/responses/RcError"
1637
1632
  "5XX":
1638
1633
  $ref: "#/components/responses/RcError"
1634
+ operationId: vfsQueueSetExpiry
1639
1635
  /vfs/refresh:
1640
1636
  post:
1641
1637
  summary: "Refresh directory cache"
1642
1638
  description: "Refreshes one or more directories in the VFS cache, optionally recursively."
1643
1639
  tags: []
1644
- operationId: vfsRefresh
1645
1640
  parameters:
1646
1641
  - $ref: "#/components/parameters/Vfs_RefreshPostFsParam"
1647
1642
  - $ref: "#/components/parameters/Vfs_RefreshPostRecursiveParam"
@@ -1655,12 +1650,12 @@ paths:
1655
1650
  $ref: "#/components/responses/RcError"
1656
1651
  "5XX":
1657
1652
  $ref: "#/components/responses/RcError"
1653
+ operationId: vfsRefresh
1658
1654
  /vfs/stats:
1659
1655
  post:
1660
1656
  summary: "Show VFS stats"
1661
1657
  description: "Returns VFS statistics including disk cache usage and metadata cache counters."
1662
1658
  tags: []
1663
- operationId: vfsStats
1664
1659
  parameters:
1665
1660
  - $ref: "#/components/parameters/Vfs_StatsPostFsParam"
1666
1661
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1672,12 +1667,12 @@ paths:
1672
1667
  $ref: "#/components/responses/RcError"
1673
1668
  "5XX":
1674
1669
  $ref: "#/components/responses/RcError"
1670
+ operationId: vfsStats
1675
1671
  /pluginsctl/addPlugin:
1676
1672
  post:
1677
1673
  summary: "Install plugin"
1678
1674
  description: "Downloads and installs a plugin into the WebUI from the provided repository URL."
1679
1675
  tags: []
1680
- operationId: pluginsctlAddPlugin
1681
1676
  parameters:
1682
1677
  - $ref: "#/components/parameters/Pluginsctl_AddPluginPostUrlParam"
1683
1678
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1689,12 +1684,12 @@ paths:
1689
1684
  $ref: "#/components/responses/RcError"
1690
1685
  "5XX":
1691
1686
  $ref: "#/components/responses/RcError"
1687
+ operationId: pluginsctlAddPlugin
1692
1688
  /pluginsctl/getPluginsForType:
1693
1689
  post:
1694
1690
  summary: "Filter plugins by MIME type"
1695
1691
  description: "Returns plugins matching the requested MIME type and optional plugin type."
1696
1692
  tags: []
1697
- operationId: pluginsctlGetPluginsForType
1698
1693
  parameters:
1699
1694
  - $ref: "#/components/parameters/Pluginsctl_GetPluginsForTypePostTypeParam"
1700
1695
  - $ref: "#/components/parameters/Pluginsctl_GetPluginsForTypePostPluginTypeParam"
@@ -1707,12 +1702,12 @@ paths:
1707
1702
  $ref: "#/components/responses/RcError"
1708
1703
  "5XX":
1709
1704
  $ref: "#/components/responses/RcError"
1705
+ operationId: pluginsctlGetPluginsForType
1710
1706
  /pluginsctl/listPlugins:
1711
1707
  post:
1712
1708
  summary: "List installed plugins"
1713
1709
  description: "Returns metadata for installed production and test plugins."
1714
1710
  tags: []
1715
- operationId: pluginsctlListPlugins
1716
1711
  parameters:
1717
1712
  - $ref: "#/components/parameters/GlobalGroupParam"
1718
1713
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1723,12 +1718,12 @@ paths:
1723
1718
  $ref: "#/components/responses/RcError"
1724
1719
  "5XX":
1725
1720
  $ref: "#/components/responses/RcError"
1721
+ operationId: pluginsctlListPlugins
1726
1722
  /pluginsctl/listTestPlugins:
1727
1723
  post:
1728
1724
  summary: "List installed test plugins"
1729
1725
  description: "Returns metadata for installed test plugins."
1730
1726
  tags: []
1731
- operationId: pluginsctlListTestPlugins
1732
1727
  parameters:
1733
1728
  - $ref: "#/components/parameters/GlobalGroupParam"
1734
1729
  - $ref: "#/components/parameters/GlobalAsyncParam"
@@ -1739,12 +1734,12 @@ paths:
1739
1734
  $ref: "#/components/responses/RcError"
1740
1735
  "5XX":
1741
1736
  $ref: "#/components/responses/RcError"
1737
+ operationId: pluginsctlListTestPlugins
1742
1738
  /pluginsctl/removePlugin:
1743
1739
  post:
1744
1740
  summary: "Remove plugin"
1745
1741
  description: "Uninstalls a plugin from the WebUI."
1746
1742
  tags: []
1747
- operationId: pluginsctlRemovePlugin
1748
1743
  parameters:
1749
1744
  - $ref: "#/components/parameters/Pluginsctl_RemovePluginPostNameParam"
1750
1745
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1756,12 +1751,12 @@ paths:
1756
1751
  $ref: "#/components/responses/RcError"
1757
1752
  "5XX":
1758
1753
  $ref: "#/components/responses/RcError"
1754
+ operationId: pluginsctlRemovePlugin
1759
1755
  /pluginsctl/removeTestPlugin:
1760
1756
  post:
1761
1757
  summary: "Remove test plugin"
1762
1758
  description: "Uninstalls a test plugin from the WebUI."
1763
1759
  tags: []
1764
- operationId: pluginsctlRemoveTestPlugin
1765
1760
  parameters:
1766
1761
  - $ref: "#/components/parameters/Pluginsctl_RemoveTestPluginPostNameParam"
1767
1762
  - $ref: "#/components/parameters/GlobalGroupParam"
@@ -1773,6 +1768,7 @@ paths:
1773
1768
  $ref: "#/components/responses/RcError"
1774
1769
  "5XX":
1775
1770
  $ref: "#/components/responses/RcError"
1771
+ operationId: pluginsctlRemoveTestPlugin
1776
1772
  components:
1777
1773
  parameters:
1778
1774
  GlobalAsyncParam:
@@ -4690,9 +4686,8 @@ components:
4690
4686
  Hide:
4691
4687
  type: boolean
4692
4688
  MetadataInfo:
4689
+ $ref: "#/components/schemas/ConfigProviderMetadataInfo"
4693
4690
  nullable: true
4694
- allOf:
4695
- - $ref: "#/components/schemas/ConfigProviderMetadataInfo"
4696
4691
  Name:
4697
4692
  type: string
4698
4693
  Options:
@@ -4971,4 +4966,4 @@ components:
4971
4966
  size:
4972
4967
  type: number
4973
4968
  description: "Total size in bytes of the object."
4974
- additionalProperties: true
4969
+ additionalProperties: true