-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdevbox-devboxes.yaml
More file actions
2008 lines (2008 loc) · 62.2 KB
/
devbox-devboxes.yaml
File metadata and controls
2008 lines (2008 loc) · 62.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
naftiko: 1.0.0-alpha2
info:
label: Runloop Devboxes (devbox)
description: Runloop devboxes capability covering one Runloop business surface. 40 operations.
tags:
- Runloop
- Devboxes
- AI Agents
- Sandboxes
created: '2026-05-25'
modified: '2026-05-25'
binds:
- namespace: env
keys:
RUNLOOP_API_KEY: RUNLOOP_API_KEY
capability:
consumes:
- type: http
namespace: devbox-devboxes
baseUri: https://api.runloop.ai
description: Runloop devboxes business capability. Self-contained, no shared references.
resources:
- name: v1-devboxes
path: /v1/devboxes
operations:
- name: createDevbox
method: POST
description: Create a Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: listDevboxes
method: GET
description: List Devboxes.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: status
in: query
type: string
description: Filter by status
required: false
- name: limit
in: query
type: integer
description: The limit of items to return. Default is 20. Max is 5000.
required: false
- name: starting_after
in: query
type: string
description: Load the next page of data starting after the item with the given ID.
required: false
- name: include_total_count
in: query
type: boolean
description: If true (default), includes total_count in the response. Set to false to skip the count query for better
performance on large datasets.
required: false
- name: v1-devboxes-disk-snapshots
path: /v1/devboxes/disk_snapshots
operations:
- name: getDevboxDiskSnapshotList
method: GET
description: List disk snapshots of a Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: devbox_id
in: query
type: string
description: Devbox ID to filter by.
required: false
- name: source_blueprint_id
in: query
type: string
description: Source Blueprint ID to filter snapshots by.
required: false
- name: metadata[key]
in: query
type: string
description: Filter snapshots by metadata key-value pair. Can be used multiple times for different keys.
required: false
- name: metadata[key][in]
in: query
type: string
description: Filter snapshots by metadata key with multiple possible values (OR condition).
required: false
- name: limit
in: query
type: integer
description: The limit of items to return. Default is 20. Max is 5000.
required: false
- name: starting_after
in: query
type: string
description: Load the next page of data starting after the item with the given ID.
required: false
- name: include_total_count
in: query
type: boolean
description: If true (default), includes total_count in the response. Set to false to skip the count query for better
performance on large datasets.
required: false
- name: v1-devboxes-disk-snapshots-list-public
path: /v1/devboxes/disk_snapshots/list_public
operations:
- name: listPublicSnapshots
method: GET
description: List public disk snapshots.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: devbox_id
in: query
type: string
description: Devbox ID to filter by.
required: false
- name: source_blueprint_id
in: query
type: string
description: Source Blueprint ID to filter snapshots by.
required: false
- name: metadata[key]
in: query
type: string
description: Filter snapshots by metadata key-value pair. Can be used multiple times for different keys.
required: false
- name: metadata[key][in]
in: query
type: string
description: Filter snapshots by metadata key with multiple possible values (OR condition).
required: false
- name: limit
in: query
type: integer
description: The limit of items to return. Default is 20. Max is 5000.
required: false
- name: starting_after
in: query
type: string
description: Load the next page of data starting after the item with the given ID.
required: false
- name: include_total_count
in: query
type: boolean
description: If true (default), includes total_count in the response. Set to false to skip the count query for better
performance on large datasets.
required: false
- name: v1-devboxes-disk-snapshots-metadata-keys
path: /v1/devboxes/disk_snapshots/metadata/keys
operations:
- name: getSnapshotMetadataKeys
method: GET
description: List available snapshot metadata keys.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: _
in: query
type: string
description: ''
required: false
- name: v1-devboxes-disk-snapshots-metadata-keys-key-values
path: /v1/devboxes/disk_snapshots/metadata/keys/{key}/values
operations:
- name: getSnapshotMetadataValues
method: GET
description: List values for a specific snapshot metadata key.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: key
in: path
type: string
description: The metadata key to get values for.
required: true
- name: v1-devboxes-disk-snapshots-public-metadata-keys
path: /v1/devboxes/disk_snapshots/public/metadata/keys
operations:
- name: getPublicSnapshotMetadataKeys
method: GET
description: List available public snapshot metadata keys.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: _
in: query
type: string
description: ''
required: false
- name: v1-devboxes-disk-snapshots-public-metadata-keys-key-values
path: /v1/devboxes/disk_snapshots/public/metadata/keys/{key}/values
operations:
- name: getPublicSnapshotMetadataValues
method: GET
description: List values for a specific public snapshot metadata key.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: key
in: path
type: string
description: The metadata key to get values for from public snapshots.
required: true
- name: v1-devboxes-disk-snapshots-id
path: /v1/devboxes/disk_snapshots/{id}
operations:
- name: updateDiskSnapshot
method: POST
description: Update metadata of Disk Snapshot.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Snapshot ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-disk-snapshots-id-delete
path: /v1/devboxes/disk_snapshots/{id}/delete
operations:
- name: deleteSnapshot
method: POST
description: Delete a disk snapshot of a Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The ID of the snapshot.
required: true
- name: v1-devboxes-disk-snapshots-id-status
path: /v1/devboxes/disk_snapshots/{id}/status
operations:
- name: queryDiskSnapshotAsync
method: GET
description: Query the status of an asynchronous disk snapshot.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Snapshot ID.
required: true
- name: v1-devboxes-metadata-keys
path: /v1/devboxes/metadata/keys
operations:
- name: getDevboxMetadataKeys
method: GET
description: List available devbox metadata keys.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: _
in: query
type: string
description: ''
required: false
- name: v1-devboxes-metadata-keys-key-values
path: /v1/devboxes/metadata/keys/{key}/values
operations:
- name: getDevboxMetadataValues
method: GET
description: List values for a specific devbox metadata key.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: key
in: path
type: string
description: The metadata key to get values for.
required: true
- name: v1-devboxes-devbox-id-executions-execution-id
path: /v1/devboxes/{devbox_id}/executions/{execution_id}
operations:
- name: queryAsyncCommand
method: GET
description: Get status of an asynchronous execution on a Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: devbox_id
in: path
type: string
description: The Devbox ID
required: true
- name: execution_id
in: path
type: string
description: The Execution ID
required: true
- name: last_n
in: query
type: string
description: 'Last n lines of standard error / standard out to return (default: 100)'
required: false
- name: v1-devboxes-devbox-id-executions-execution-id-kill
path: /v1/devboxes/{devbox_id}/executions/{execution_id}/kill
operations:
- name: killAsyncExecution
method: POST
description: Kill an asynchronous execution currently running on a devbox
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: devbox_id
in: path
type: string
description: The Devbox ID.
required: true
- name: execution_id
in: path
type: string
description: The Async Execution ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-devbox-id-executions-execution-id-send-std-in
path: /v1/devboxes/{devbox_id}/executions/{execution_id}/send_std_in
operations:
- name: sendStdIn
method: POST
description: Send Content to Std In for a running execution.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: devbox_id
in: path
type: string
description: The Devbox ID.
required: true
- name: execution_id
in: path
type: string
description: The Async Execution ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-devbox-id-executions-execution-id-wait-for-status
path: /v1/devboxes/{devbox_id}/executions/{execution_id}/wait_for_status
operations:
- name: waitForCommandCompletion
method: POST
description: Wait for an asynchronous execution to reach a specific status.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: devbox_id
in: path
type: string
description: The Devbox ID.
required: true
- name: execution_id
in: path
type: string
description: The Async Execution ID.
required: true
- name: last_n
in: query
type: string
description: 'Last n lines of standard error / standard out to return (default: 100)'
required: false
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id
path: /v1/devboxes/{id}
operations:
- name: updateDevbox
method: POST
description: Update a Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: getDevbox
method: GET
description: Get Devbox details.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-create-pty-tunnel
path: /v1/devboxes/{id}/create_pty_tunnel
operations:
- name: createDevboxPtyTunnel
method: POST
description: Create an ephemeral PTY tunnel for a running Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-create-ssh-key
path: /v1/devboxes/{id}/create_ssh_key
operations:
- name: createDevboxSshKey
method: POST
description: Create an SSH key for a Devbox
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-download-file
path: /v1/devboxes/{id}/download_file
operations:
- name: devboxDownloadFile
method: POST
description: Download binary file contents from Devbox filesystem.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-enable-tunnel
path: /v1/devboxes/{id}/enable_tunnel
operations:
- name: enableDevboxTunnel
method: POST
description: Enable a tunnel for a running Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-execute
path: /v1/devboxes/{id}/execute
operations:
- name: executeCommand
method: POST
description: Execute a command with a known ID, optimistically waiting for completion
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: last_n
in: query
type: string
description: 'Last n lines of standard error / standard out to return (default: 100)'
required: false
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-execute-async
path: /v1/devboxes/{id}/execute_async
operations:
- name: execAsyncCommand
method: POST
description: Asynchronously execute a command via the Devbox shell
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-execute-sync
path: /v1/devboxes/{id}/execute_sync
operations:
- name: execSyncCommand
method: POST
description: (Deprecated, please use /execute_async) Synchronously execute a shell command on a Devbox
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-keep-alive
path: /v1/devboxes/{id}/keep_alive
operations:
- name: keepAliveDevbox
method: POST
description: Reset the idle timer of a running Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-logs
path: /v1/devboxes/{id}/logs
operations:
- name: listDevboxLogs
method: GET
description: Get Devbox logs.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: execution_id
in: query
type: string
description: ID of execution to filter logs by.
required: false
- name: shell_name
in: query
type: string
description: Shell Name to filter logs by.
required: false
- name: v1-devboxes-id-logs-tail
path: /v1/devboxes/{id}/logs/tail
operations:
- name: tailDevboxLogs
method: GET
description: Live Tail Devbox Logs.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: execution_id
in: query
type: string
description: ID of execution to filter logs by.
required: false
- name: shell_name
in: query
type: string
description: Shell Name to filter logs by.
required: false
- name: v1-devboxes-id-read-file-contents
path: /v1/devboxes/{id}/read_file_contents
operations:
- name: devboxReadFileContents
method: POST
description: Read text file contents from Devbox filesystem.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-remove-tunnel
path: /v1/devboxes/{id}/remove_tunnel
operations:
- name: removeDevboxTunnel
method: POST
description: Remove a tunnel from the Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-resume
path: /v1/devboxes/{id}/resume
operations:
- name: resumeDevbox
method: POST
description: Resume a suspended Devbox
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-shutdown
path: /v1/devboxes/{id}/shutdown
operations:
- name: shutdownDevbox
method: POST
description: Shutdown a running Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: force
in: query
type: string
description: If true, force shutdown even if snapshots are in progress. Defaults to false.
required: false
- name: v1-devboxes-id-snapshot-disk
path: /v1/devboxes/{id}/snapshot_disk
operations:
- name: createDiskSnapshot
method: POST
description: Synchronously create a disk snapshot of a running Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-snapshot-disk-async
path: /v1/devboxes/{id}/snapshot_disk_async
operations:
- name: createDiskSnapshotAsync
method: POST
description: Start an asynchronous disk snapshot of a running Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-suspend
path: /v1/devboxes/{id}/suspend
operations:
- name: suspendDevbox
method: POST
description: Suspend a running Devbox
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-upload-file
path: /v1/devboxes/{id}/upload_file
operations:
- name: devboxUploadFile
method: POST
description: Upload binary file contents to Devbox filesystem.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-usage
path: /v1/devboxes/{id}/usage
operations:
- name: getDevboxResourceUsage
method: GET
description: Get resource usage for a Devbox.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: v1-devboxes-id-wait-for-status
path: /v1/devboxes/{id}/wait_for_status
operations:
- name: waitForDevboxStatus
method: POST
description: Wait for a Devbox to reach one of the specified statuses.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
- name: v1-devboxes-id-write-file-contents
path: /v1/devboxes/{id}/write_file_contents
operations:
- name: devboxWriteFileContents
method: POST
description: Write text file contents to Devbox filesystem.
outputRawFormat: json
outputParameters:
- name: result
type: object
value: $.
inputParameters:
- name: id
in: path
type: string
description: The Devbox ID.
required: true
- name: body
in: body
type: object
description: Request body (JSON).
required: false
authentication:
type: bearer
value: '{{env.RUNLOOP_API_KEY}}'
placement: header
exposes:
- type: rest
namespace: devbox-devboxes-rest
port: 8080
description: REST adapter for Runloop devboxes. One Spectral-compliant resource per consumed operation.
resources:
- path: /v1/devboxes
name: v1-devboxes
description: REST surface for v1-devboxes.
operations:
- method: POST
name: createDevbox
description: Create a Devbox.
call: devbox-devboxes.createDevbox
with:
body: rest.body
outputParameters:
- type: object
mapping: $.
- method: GET
name: listDevboxes
description: List Devboxes.
call: devbox-devboxes.listDevboxes
with:
status: rest.params.status
limit: rest.params.limit
starting_after: rest.params.starting_after
include_total_count: rest.params.include_total_count
outputParameters:
- type: object
mapping: $.
- path: /v1/devboxes/disk_snapshots
name: v1-devboxes-disk-snapshots
description: REST surface for v1-devboxes-disk-snapshots.
operations:
- method: GET
name: getDevboxDiskSnapshotList
description: List disk snapshots of a Devbox.
call: devbox-devboxes.getDevboxDiskSnapshotList
with:
devbox_id: rest.params.devbox_id
source_blueprint_id: rest.params.source_blueprint_id
metadata[key]: rest.params.metadata[key]
metadata[key][in]: rest.params.metadata[key][in]
limit: rest.params.limit
starting_after: rest.params.starting_after
include_total_count: rest.params.include_total_count
outputParameters:
- type: object
mapping: $.
- path: /v1/devboxes/disk_snapshots/list_public
name: v1-devboxes-disk-snapshots-list-public
description: REST surface for v1-devboxes-disk-snapshots-list-public.
operations:
- method: GET
name: listPublicSnapshots
description: List public disk snapshots.
call: devbox-devboxes.listPublicSnapshots
with:
devbox_id: rest.params.devbox_id
source_blueprint_id: rest.params.source_blueprint_id
metadata[key]: rest.params.metadata[key]
metadata[key][in]: rest.params.metadata[key][in]
limit: rest.params.limit
starting_after: rest.params.starting_after
include_total_count: rest.params.include_total_count
outputParameters:
- type: object
mapping: $.
- path: /v1/devboxes/disk_snapshots/metadata/keys
name: v1-devboxes-disk-snapshots-metadata-keys
description: REST surface for v1-devboxes-disk-snapshots-metadata-keys.
operations:
- method: GET
name: getSnapshotMetadataKeys
description: List available snapshot metadata keys.
call: devbox-devboxes.getSnapshotMetadataKeys
with:
_: rest.params._
outputParameters:
- type: object
mapping: $.