-
Notifications
You must be signed in to change notification settings - Fork 5
/
openapi.yaml
6278 lines (6215 loc) · 185 KB
/
openapi.yaml
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
openapi: 3.0.0
info:
title: Crusoe Cloud API Gateway
description: >-
The API Gateway exposes all publicly available API endpoints for Crusoe
Cloud products.
version: v1alpha5
x-konfig-ignore:
potential-incorrect-type: true
servers:
- url: https://api.crusoecloud.com/v1alpha5
tags:
- name: VMs
- name: Projects
- name: Instance-Groups
- name: Load-Balancers
- name: VPC-Firewall-Rules
- name: VPC-Networks
- name: VPC-Subnets
- name: Disks
- name: Entities
- name: Instance-Templates
- name: IB-Partitions
- name: Snapshots
- name: Usage
- name: Identities
- name: SSH-Keys
- name: Tokens
- name: Images
- name: VM-Operations
- name: IB-Networks
- name: Load-Balancer-Operations
- name: VPC-Firewall-Rule-Operations
- name: VPC-Network-Operations
- name: VPC-Subnet-Operations
- name: Disk-Operations
- name: Snapshot-Operations
- name: Capacities
- name: Feature-Flags
- name: Locations
- name: Billing
- name: Prospects
paths:
/capacities:
get:
tags:
- Capacities
summary: >-
Lists available Crusoe Cloud capacity with optional filters on location
and product name.
operationId: Capacities_listAvailable
parameters:
- example: '[a100.1x, a100.2x]'
x-go-name: ProductNames
name: product_name
in: query
style: form
explode: false
schema:
type: array
items:
type: string
- example: '[us-northcentral1-a, us-northcentral1-b]'
x-go-name: Locations
name: location
in: query
style: form
explode: false
schema:
type: array
items:
type: string
responses:
'200':
$ref: '#/components/responses/capacitiesResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
/compute/images:
get:
tags:
- Images
summary: Lists all VM images available for use.
operationId: Images_listAvailableVMImages
responses:
'200':
$ref: '#/components/responses/listImagesResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
/compute/images/{image_id}:
get:
tags:
- Images
summary: Retrieve details about a VM image.
operationId: Images_getDetails
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ImageID
name: image_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/getImageResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'404':
$ref: '#/components/responses/notFoundError'
'500':
$ref: '#/components/responses/serverError'
/featureflags:
get:
tags:
- Feature-Flags
summary: Get feature flags for the currently logged in user.
operationId: FeatureFlags_getUserFlags
description: |-
A successful response from this resource will contain a map of
all feature flags and the value assigned to each of them for the user.
responses:
'200':
$ref: '#/components/responses/featureFlagsGetResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
/locations:
get:
tags:
- Locations
summary: Lists all Crusoe Cloud locations usable for resource hosting.
operationId: Locations_listUsableLocations
responses:
'200':
$ref: '#/components/responses/locationsResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
/organizations/billing/intent:
get:
tags:
- Billing
summary: Retrieve an intent to facilitate a Stripe action.
operationId: Billing_getIntent
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: OrgID
name: org_id
in: query
required: true
schema:
type: string
- x-go-name: Type
name: intent_type
in: query
required: true
schema:
type: string
enum:
- dashboard
responses:
'200':
$ref: '#/components/responses/billingIntentGetResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
/organizations/entities:
get:
tags:
- Entities
summary: >-
Retrieve details about all active organizations the logged in user
belongs to.
operationId: Entities_getDetailsAllActive
responses:
'200':
$ref: '#/components/responses/organizationsGetResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
put:
tags:
- Entities
summary: Update details for an organization that the logged in user owns.
operationId: Entities_updateOrganizationDetails
description: >-
A successful response from this resource will contain the updated
organization details.
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: OrgID
name: org_id
in: query
required: true
schema:
type: string
requestBody:
$ref: '#/components/requestBodies/EntitiesPutPostRequest'
responses:
'200':
$ref: '#/components/responses/organizationsPutPostResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
post:
tags:
- Entities
summary: Create a new organization owned by the logged in user.
operationId: Entities_createNewOrganization
description: >-
A successful response from this resource will contain the json encoded
organization details.
requestBody:
$ref: '#/components/requestBodies/EntitiesPutPostRequest'
responses:
'200':
$ref: '#/components/responses/organizationsPutPostResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
delete:
tags:
- Entities
summary: Delete an organization owned by the logged in user.
operationId: Entities_removeOrganization
description: >-
Delete operations will cascade to projects and VMs, and all members will
be removed from the organization.
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: OrgID
name: org_id
in: query
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/emptyResponse'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
/organizations/projects:
get:
tags:
- Projects
summary: >-
Retrieve details about projects that the logged in user belongs to or
owns.
operationId: Projects_getDetails
description: >-
If querying for projects within an organization, the logged in user must
be the owner of the organization.
parameters:
- example: ee2a6bc3-aed5-4756-8995-9990a53d3a17
x-go-name: OrgID
name: org_id
in: query
schema:
type: string
- example: default
x-go-name: ProjectName
name: project_name
in: query
schema:
type: string
responses:
'200':
$ref: '#/components/responses/listProjectsResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
put:
tags:
- Projects
summary: Update details for a project that the logged in user owns.
operationId: Projects_updateDetails
description: >-
Requests to this resource must contain the json-encoded representation
of the changes they want to make to the project.
Currently only the project's name can be changed.
parameters:
- example: f058d0db-2fa4-4cf2-8cf1-dfbcfe05a814
x-go-name: ProjectID
name: project_id
in: query
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsPutRequest'
required: true
responses:
'200':
$ref: '#/components/responses/projectsPutPostResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
post:
tags:
- Projects
summary: Create a new project that will be owned by the logged in user.
operationId: Projects_createOwnedProject
description: >-
The logged in user must have the permission to create projects within
the organization.
A successful response from this resource contains details of the created
project.
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProjectsPostRequest'
required: true
responses:
'200':
$ref: '#/components/responses/projectsPutPostResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
/organizations/projects/{project_id}:
get:
tags:
- Projects
summary: >-
Retrieve details about a project that the logged in user belongs to or
owns.
operationId: Projects_getDetails
parameters:
- example: ee2a6bc3-aed5-4756-8995-9990a53d3a17
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/getProjectResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
delete:
tags:
- Projects
summary: Delete a project that the logged in user owns.
operationId: Projects_deleteOwnedProject
description: Delete operations cascade to VMs created under that project.
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/emptyResponse'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
/organizations/prospects:
post:
tags:
- Prospects
summary: Create a new prospective customer in Crusoe Cloud.
operationId: Prospects_createNewProspect
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ProspectPostRequest'
required: true
responses:
'200':
$ref: '#/components/responses/prospectPostResponse'
'400':
$ref: '#/components/responses/badReqError'
'500':
$ref: '#/components/responses/serverError'
/organizations/usage:
get:
tags:
- Usage
summary: Get project-level usage for products in Crusoe Cloud.
operationId: Usage_getProjectUsage
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: OrgID
name: org_id
in: query
required: true
schema:
type: string
- example:
- d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
x-go-name: Projects
name: projects
in: query
required: true
style: form
explode: false
schema:
type: array
items:
type: string
- example:
- persistent-ssd
- a40.1x
x-go-name: ResourceTypes
name: resource_types
in: query
required: true
style: form
explode: false
schema:
type: array
items:
type: string
- example:
- us-east1
- us-northcentral1
x-go-name: Regions
name: regions
in: query
required: true
style: form
explode: false
schema:
type: array
items:
type: string
- example: '"2022-07-01"'
x-go-name: StartDate
name: start_date
in: query
required: true
schema:
type: string
- example: '"2023-08-08"'
x-go-name: EndDate
name: end_date
in: query
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/usageGetResponse'
'400':
$ref: '#/components/responses/badReqError'
'500':
$ref: '#/components/responses/serverError'
/organizations/usage/export:
get:
tags:
- Usage
summary: Get resource-level usage for products in Crusoe Cloud.
operationId: Usage_exportResourceUsage
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: OrgID
name: org_id
in: query
required: true
schema:
type: string
- example:
- d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
x-go-name: Projects
name: projects
in: query
required: true
style: form
explode: false
schema:
type: array
items:
type: string
- example:
- d8f58dfd-dd86-4ee4-8f01-643e6d0f15bb
x-go-name: Resources
name: resources
in: query
required: true
style: form
explode: false
schema:
type: array
items:
type: string
- example:
- persistent-ssd
- a40.1x
x-go-name: ResourceTypes
name: resource_types
in: query
required: true
style: form
explode: false
schema:
type: array
items:
type: string
- example:
- us-east1
- us-northcentral1
x-go-name: Regions
name: regions
in: query
required: true
style: form
explode: false
schema:
type: array
items:
type: string
- example: '"2022-07-01"'
x-go-name: StartDate
name: start_date
in: query
required: true
schema:
type: string
- example: '"2023-08-08"'
x-go-name: EndDate
name: end_date
in: query
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/usageExportGetResponse'
'400':
$ref: '#/components/responses/badReqError'
'500':
$ref: '#/components/responses/serverError'
/organizations/usage/options:
get:
tags:
- Usage
summary: Get options which exist for filters for /usage and /usage/export routes.
operationId: Usage_getOptionFilters
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: OrgID
name: org_id
in: query
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/usageOptionsGetResponse'
'500':
$ref: '#/components/responses/serverError'
/projects/{project_id}/compute/instance-groups:
get:
tags:
- Instance-Groups
summary: Lists all instance groups.
operationId: InstanceGroups_listAll
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/listInstanceGroupsResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
post:
tags:
- Instance-Groups
summary: Create an instance group.
operationId: InstanceGroups_createInstanceGroup
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceGroupPostRequest'
required: true
responses:
'200':
$ref: '#/components/responses/createInstanceGroupResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
/projects/{project_id}/compute/instance-groups/{instance_group_id}:
get:
tags:
- Instance-Groups
summary: Retrieve details about an instance group.
operationId: InstanceGroups_getDetails
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: InstanceGroupID
name: instance_group_id
in: path
required: true
schema:
type: string
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/getInstanceGroupResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'404':
$ref: '#/components/responses/notFoundError'
'500':
$ref: '#/components/responses/serverError'
delete:
tags:
- Instance-Groups
summary: Delete an instance group.
operationId: InstanceGroups_removeInstanceGroup
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: InstanceGroupID
name: instance_group_id
in: path
required: true
schema:
type: string
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/emptyResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
patch:
tags:
- Instance-Groups
summary: Update an instance group.
operationId: InstanceGroups_updateInstanceGroup
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: InstanceGroupID
name: instance_group_id
in: path
required: true
schema:
type: string
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceGroupPatchRequest'
required: true
responses:
'200':
$ref: '#/components/responses/patchInstanceGroupResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
/projects/{project_id}/compute/instance-templates:
get:
tags:
- Instance-Templates
summary: Lists all VM instance templates available for use.
operationId: InstanceTemplates_listAvailableVmTemplates
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/listInstanceTemplatesResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
post:
tags:
- Instance-Templates
summary: Create a VM instance template, for use in bulk VM creation.
operationId: InstanceTemplates_createVmTemplate
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceTemplatePostRequestV1Alpha5'
required: true
responses:
'200':
$ref: '#/components/responses/createInstanceTemplateResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
/projects/{project_id}/compute/instance-templates/{instance_template_id}:
get:
tags:
- Instance-Templates
summary: Retrieve details about a VM instance template.
operationId: InstanceTemplates_getDetails
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: InstanceTemplateID
name: instance_template_id
in: path
required: true
schema:
type: string
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/getInstanceTemplateResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'404':
$ref: '#/components/responses/notFoundError'
'500':
$ref: '#/components/responses/serverError'
delete:
tags:
- Instance-Templates
summary: Delete a VM instance template.
operationId: InstanceTemplates_deleteVmTemplate
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: InstanceTemplateID
name: instance_template_id
in: path
required: true
schema:
type: string
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
responses:
'200':
$ref: '#/components/responses/emptyResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
/projects/{project_id}/compute/vms/bulk-instances:
post:
tags:
- VMs
summary: Create new VM instances owned by the logged in user.
operationId: VMs_createBulkInstances
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BulkInstancePostRequestV1Alpha5'
required: true
responses:
'200':
$ref: '#/components/responses/asyncOperationResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
/projects/{project_id}/compute/vms/instances:
get:
tags:
- VMs
summary: >-
Retrieve details about all VMs that the logged in user owns or has
access to.
operationId: VMs_getAllOwnedInstances
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: IDs
name: ids
in: query
schema:
type: string
- example: my-first-vm
x-go-name: Names
name: names
in: query
schema:
type: string
- example: a40.2x,a100.8x
x-go-name: Types
name: types
in: query
schema:
type: string
- example: us-east1,us-northcentral1
x-go-name: Locations
name: locations
in: query
schema:
type: string
- example: STATE_RUNNING
x-go-name: States
name: states
in: query
schema:
type: string
- example: '20'
x-go-name: Limit
name: limit
in: query
schema:
type: string
- example: name
x-go-name: Sort
name: sort
in: query
schema:
type: string
- example: bXktZmlyc3Qtdm0
x-go-name: NextToken
name: next_token
in: query
schema:
type: string
- example: bXktZmlyc3Qtdm0
x-go-name: PrevToken
name: prev_token
in: query
schema:
type: string
responses:
'200':
$ref: '#/components/responses/listInstancesResponse'
'401':
$ref: '#/components/responses/authError'
'500':
$ref: '#/components/responses/serverError'
post:
tags:
- VMs
summary: Create a new VM instance owned by the logged in user.
operationId: VMs_createInstance
parameters:
- example: ab4a6b00-aa5f-408e-a9fb-ac6de5eb45ab
x-go-name: ProjectID
name: project_id
in: path
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/InstancesPostRequestV1Alpha5'
required: true
responses:
'200':
$ref: '#/components/responses/asyncOperationResponse'
'400':
$ref: '#/components/responses/badReqError'
'401':
$ref: '#/components/responses/authError'
'403':
$ref: '#/components/responses/permissionsError'
'500':
$ref: '#/components/responses/serverError'
/projects/{project_id}/compute/vms/instances/operations:
get: