generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathopenapi.yaml
1449 lines (1437 loc) · 45.5 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
servers:
- description: Shadeform Production
url: https://api.shadeform.ai/v1
info:
description: 'Shadeform is a single API and platform for deploying and managing cloud GPUs.'
version: 1.0.0
title: Shadeform API
contact:
name: Ronald Ding
email: [email protected]
url: www.shadeform.ai
security:
- ApiKeyAuth: []
paths:
/instances:
get:
summary: /instances
operationId: instances
description: 'Get active and pending instances.'
responses:
'200':
description: 'Returns an InstancesResponse object.'
content:
application/json:
schema:
$ref: '#/components/schemas/InstancesResponse'
/instances/types:
get:
parameters:
- in: query
name: cloud
schema:
type: string
example: aws
description: "Filter the instance type results by cloud."
- in: query
name: region
schema:
type: string
example: us-east-1a
description: "Filter the instance type results by region."
- in: query
name: num_gpus
schema:
type: string
example: 1
description: "Filter the instance type results by the number of gpus."
- in: query
name: gpu_type
schema:
type: string
example: A100_80G
description: "Filter the instance type results by gpu type."
- in: query
name: shade_instance_type
schema:
type: string
example: A100_80G
description: "Filter the instance type results by the shade instance type."
- in: query
name: available
schema:
type: boolean
example: true
description: "Filter the instance type results by availability."
- in: query
name: sort
schema:
type: string
enum:
- price
example: price
description: "Sort the order of the instance type results."
summary: /instances/types
operationId: GetInstanceTypes
description: 'Return all the GPU instance types with their corresponding availability and specs.'
responses:
'200':
description: Returns an InstanceTypesResponse object
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceTypesResponse'
/instances/create:
post:
summary: /instances/create
operationId: Create
description: 'Create a new GPU instance.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateRequest'
responses:
'200':
description: Returns a CreateResponse object
content:
application/json:
schema:
$ref: '#/components/schemas/CreateResponse'
'/instances/{id}/info':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: 'The instance id'
get:
summary: /instances/{id}/info
operationId: instances/info
description: "Get details for the specified instance in the url."
responses:
'200':
description: "Return an instance object."
content:
application/json:
schema:
$ref: '#/components/schemas/InstanceInfoResponse'
'/instances/{id}/update':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: 'The instance id'
post:
summary: /instances/{id}/update
operationId: instances/update
description: "Update mutable details about the instance. Set a value to null to delete it. Omit a value or leave undefined to keep unchanged."
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateRequest'
responses:
'200':
description: 'Confirms the update of an instance.'
'/instances/{id}/delete':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: The instance id
post:
summary: /instances/{id}/delete
operationId: Delete
description: "Delete an instance. Some cloud providers may only allow deletion of an instance after it has moved to the 'active' status."
responses:
'200':
description: 'Confirms the deletion of an instance.'
'/instances/{id}/restart':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: The instance id
post:
summary: /instances/{id}/restart
operationId: Restart
description: "Restart an instance. The status of the instance will stay as 'active' throughout, but you may have to wait a few minutes for the instance to be ready to use again."
responses:
'200':
description: 'Confirms the restart of an instance has been initiated. This does not confirm that the instance restarted successfully.'
'/sshkeys':
get:
summary: /sshkeys
operationId: sshkeys
description: 'Get all SSH Keys for the account.'
responses:
'200':
description: 'Returns an SSHKeysResponse object'
content:
application/json:
schema:
$ref: '#/components/schemas/SshKeysResponse'
'/sshkeys/add':
post:
summary: /sshkeys/add
operationId: Add
description: 'Add a new SSH Key'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AddSshKeyRequest'
responses:
'200':
description: 'Returns a AddSshKeyResponse object'
content:
application/json:
schema:
$ref: '#/components/schemas/AddSshKeyResponse'
'/sshkeys/{id}/delete':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: 'The ssh key id'
post:
summary: /sshkeys/{id}/delete
operationId: Delete
description: 'Delete an ssh key. The Shadeform managed SSH Key, current default ssh key, and in use SSH Keys cannot be deleted.'
responses:
'200':
description: 'Confirms the deletion of an ssh key.'
'/sshkeys/{id}/info':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: 'The ssh key id'
get:
summary: /sshkeys/{id}/info
operationId: sshkeys/info
description: "Get details for the specified SSH Key in the url."
responses:
'200':
description: "Return an SshKey object."
content:
application/json:
schema:
$ref: '#/components/schemas/SshKey'
'/sshkeys/{id}/setdefault':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: 'The ssh key id'
post:
summary: /sshkeys/{id}/setdefault
operationId: sshkeys/setdefault
description: 'Set the specified SSH Key as the default SSH Key used by Shadeform.'
responses:
'200':
description: 'Confirms that the specified SSH Key was as set as the default key.'
'/volumes':
get:
summary: /volumes
operationId: volumes
description: 'Get all storage volumes for the account.'
responses:
'200':
description: 'Returns an VolumesResponse object'
content:
application/json:
schema:
$ref: '#/components/schemas/VolumesResponse'
'/volumes/create':
post:
summary: /volumes/create
operationId: Create
description: 'Create a new storage volume'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVolumeRequest'
responses:
'200':
description: 'Returns a CreateVolumeResponse object'
content:
application/json:
schema:
$ref: '#/components/schemas/CreateVolumeResponse'
'/volumes/{id}/delete':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: 'The volume id.'
post:
summary: /volumes/{id}/delete
operationId: Delete
description: 'Delete a storage volume.'
responses:
'200':
description: 'Confirms the deletion of the specified storage volume.'
'/volumes/{id}/info':
parameters:
- in: path
name: id
required: true
example: 'd290f1ee-6c54-4b01-90e6-d701748f0851'
schema:
type: string
minimum: 1
description: 'The volume id.'
get:
summary: /volumes/{id}/info
operationId: volumes/info
description: "Get details for the specified storage volume."
responses:
'200':
description: "Return a volume object."
content:
application/json:
schema:
$ref: '#/components/schemas/Volume'
'/volumes/types':
get:
summary: /volumes/types
operationId: volumes/types
description: 'Get list of supported storage volumes.'
responses:
'200':
description: 'Returns an VolumesTypesResponse object.'
content:
application/json:
schema:
$ref: '#/components/schemas/VolumesTypesResponse'
'/templates':
get:
summary: /templates
operationId: ListTemplates
description: 'List all templates created by the user'
responses:
'200':
description: 'Returns a list of templates'
content:
application/json:
schema:
$ref: '#/components/schemas/TemplatesResponse'
'/templates/featured':
get:
summary: /templates/featured
operationId: ListFeaturedTemplates
description: 'List featured templates'
responses:
'200':
description: 'Returns a list of featured templates'
content:
application/json:
schema:
$ref: '#/components/schemas/TemplatesResponse'
'/templates/{template_id}/info':
parameters:
- in: path
name: template_id
required: true
schema:
type: string
description: 'The template ID'
get:
summary: /templates/{template_id}/info
operationId: GetTemplateInfo
description: 'Get information about a specific template'
responses:
'200':
description: 'Returns template information'
content:
application/json:
schema:
$ref: '#/components/schemas/Template'
'/templates/save':
post:
summary: /templates/save
operationId: CreateTemplate
description: 'Create a new template'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateSaveRequest'
responses:
'200':
description: Returns a TemplateCreateResponse object
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateCreateResponse'
'/templates/{template_id}/update':
parameters:
- in: path
name: template_id
required: true
schema:
type: string
description: 'The template ID'
post:
summary: /templates/{template_id}/update
operationId: UpdateTemplate
description: 'Update an existing template'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/TemplateSaveRequest'
responses:
'200':
description: 'Template updated successfully'
'/templates/{template_id}/delete':
parameters:
- in: path
name: template_id
required: true
schema:
type: string
description: 'The template ID'
post:
summary: /templates/{template_id}/delete
operationId: DeleteTemplate
description: 'Delete a template'
responses:
'200':
description: 'Template deleted successfully'
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
schemas:
InstanceTypesResponse:
description: 'Response of /instances/types'
type: object
required:
- instance_types
properties:
instance_types:
type: array
items:
$ref: '#/components/schemas/InstanceType'
InstanceType:
description: "Information about a specific instance type"
type: object
required:
- cloud
- region
- shade_instance_type
- cloud_instance_type
- configuration
- hourly_price
- deployment_type
- availability
properties:
cloud:
$ref: '#/components/schemas/Cloud'
region:
$ref: '#/components/schemas/Region'
shade_instance_type:
$ref: '#/components/schemas/ShadeInstanceType'
cloud_instance_type:
$ref: '#/components/schemas/CloudInstanceType'
configuration:
allOf:
- $ref: '#/components/schemas/Configuration'
- type: object
required:
- os_options
properties:
os_options:
type: array
items:
type: string
example: ["ubuntu22.04_cuda12.2_shade_os", "ubuntu20.04_cuda12.0_shade_os"]
description: 'The list of available operating systems for the instance.'
hourly_price:
$ref: '#/components/schemas/HourlyPrice'
deployment_type:
$ref: '#/components/schemas/DeploymentType'
availability:
type: array
items:
$ref: '#/components/schemas/Availability'
example:
- region: us-central-1
available: true
display_name: US, Wichita, KS
- region: us-central-2
available: false
display_name: US, Wichita, KS
boot_time:
type: object
example:
min_boot_in_sec: 180
max_boot_in_sec: 300
InstancesResponse:
type: object
required:
- instances
properties:
instances:
type: array
items:
$ref: '#/components/schemas/Instance'
Instance:
type: object
required:
- id
- cloud
- region
- shade_instance_type
- cloud_instance_type
- cloud_assigned_id
- shade_cloud
- name
- configuration
- ip
- ssh_user
- ssh_port
- status
- cost_estimate
- created_at
- deleted_at
properties:
id:
$ref: '#/components/schemas/Id'
cloud:
$ref: '#/components/schemas/Cloud'
region:
$ref: '#/components/schemas/Region'
shade_instance_type:
$ref: '#/components/schemas/ShadeInstanceType'
cloud_instance_type:
$ref: '#/components/schemas/CloudInstanceType'
cloud_assigned_id:
$ref: '#/components/schemas/CloudAssignedId'
shade_cloud:
$ref: '#/components/schemas/ShadeCloud'
name:
$ref: '#/components/schemas/Name'
configuration:
allOf:
- $ref: '#/components/schemas/Configuration'
- type: object
required:
- os
properties:
os:
type: string
example: ubuntu_22_shade_os
description: "The operating system of the instance."
ip:
$ref: '#/components/schemas/Ip'
ssh_user:
$ref: '#/components/schemas/SshUser'
ssh_port:
$ref: '#/components/schemas/SshPort'
status:
$ref: '#/components/schemas/Status'
cost_estimate:
$ref: '#/components/schemas/CostEstimate'
hourly_price:
$ref: '#/components/schemas/HourlyPrice'
launch_configuration:
$ref: '#/components/schemas/LaunchConfiguration'
port_mappings:
type: array
description: 'List of port mappings on an instance that a Cloud Provider might have automatically set up.'
items:
$ref: '#/components/schemas/InstancePortMappings'
created_at:
$ref: '#/components/schemas/CreatedAt'
deleted_at:
$ref: '#/components/schemas/DeletedAt'
InstanceInfoResponse:
type: object
required:
- id
- cloud
- region
- shade_instance_type
- cloud_instance_type
- cloud_assigned_id
- shade_cloud
- name
- configuration
- ip
- ssh_user
- ssh_port
- status
- cost_estimate
- created_at
- deleted_at
properties:
id:
$ref: '#/components/schemas/Id'
cloud:
$ref: '#/components/schemas/Cloud'
region:
$ref: '#/components/schemas/Region'
shade_instance_type:
$ref: '#/components/schemas/ShadeInstanceType'
cloud_instance_type:
$ref: '#/components/schemas/CloudInstanceType'
cloud_assigned_id:
$ref: '#/components/schemas/CloudAssignedId'
shade_cloud:
$ref: '#/components/schemas/ShadeCloud'
name:
$ref: '#/components/schemas/Name'
configuration:
allOf:
- $ref: '#/components/schemas/Configuration'
- type: object
required:
- os
properties:
os:
type: string
example: ubuntu_22_shade_os
description: "The operating system of the instance."
ip:
$ref: '#/components/schemas/Ip'
ssh_user:
$ref: '#/components/schemas/SshUser'
ssh_port:
$ref: '#/components/schemas/SshPort'
status:
$ref: '#/components/schemas/Status'
cost_estimate:
$ref: '#/components/schemas/CostEstimate'
hourly_price:
$ref: '#/components/schemas/HourlyPrice'
volume_ids:
type: array
description: "List of volume IDs to be mounted. Currently only supports 1 volume at a time."
items:
$ref: '#/components/schemas/VolumeID'
ssh_key_id:
$ref: '#/components/schemas/SshKeyID'
launch_configuration:
$ref: '#/components/schemas/LaunchConfiguration'
auto_delete:
$ref: '#/components/schemas/AutoDelete'
alert:
$ref: '#/components/schemas/Alert'
volume_mount:
$ref: '#/components/schemas/VolumeMount'
tags:
type: array
description: 'Add custom, searchable tags to instances.'
items:
$ref: '#/components/schemas/Tag'
envs:
type: array
description: 'List of environment variable name and values to automatically add to the instance'
items:
$ref: '#/components/schemas/Env'
port_mappings:
type: array
description: 'List of port mappings on an instance that a Cloud Provider might have automatically set up.'
items:
$ref: '#/components/schemas/InstancePortMappings'
created_at:
$ref: '#/components/schemas/CreatedAt'
deleted_at:
$ref: '#/components/schemas/DeletedAt'
Configuration:
type: object
required:
- memory_in_gb
- storage_in_gb
- vcpus
- num_gpus
- gpu_type
- interconnect
- os
- os_options
- vram_per_gpu_in_gb
properties:
memory_in_gb:
type: integer
example: 12
description: "The amount of memory for the instance in gigabytes. Note that this is not VRAM which is determined by GPU type and the number of GPUs."
storage_in_gb:
type: integer
example: 256
description: 'The amount of storage for the instance. If this storage is too low for the instance type, please email [email protected] as the storage may be adjustable.'
vcpus:
type: integer
example: 6
description: "The number of vCPUs for the instance."
num_gpus:
type: integer
example: 1
description: "The number of GPUs for the instance."
gpu_type:
type: string
example: A100
description: "The type of GPU for the instance."
interconnect:
type: string
example: pcie
description: "The type of GPU interconnect."
vram_per_gpu_in_gb:
type: integer
example: 48
description: "The video memory per GPU for the instance in gigabytes."
Availability:
type: object
required:
- region
- available
properties:
region:
$ref: '#/components/schemas/Region'
available:
type: boolean
example: true
description: "Indicate whether the instance is available in the region."
CreateRequest:
type: object
required:
- cloud
- region
- shade_instance_type
- shade_cloud
- name
properties:
cloud:
$ref: '#/components/schemas/Cloud'
region:
$ref: '#/components/schemas/Region'
shade_instance_type:
$ref: '#/components/schemas/ShadeInstanceType'
shade_cloud:
$ref: '#/components/schemas/ShadeCloud'
name:
$ref: '#/components/schemas/Name'
os:
type: string
example: "ubuntu22.04_cuda12.2_shade_os"
description: 'The operating system of the instance.'
template_id:
type: string
example: "template-123"
description: 'The ID of the template to use for this instance'
launch_configuration:
$ref: '#/components/schemas/LaunchConfiguration'
volume_ids:
type: array
description: "List of volume IDs to be mounted. Currently only supports 1 volume at a time."
items:
$ref: '#/components/schemas/VolumeID'
ssh_key_id:
$ref: '#/components/schemas/SshKeyID'
auto_delete:
$ref: '#/components/schemas/AutoDelete'
alert:
$ref: '#/components/schemas/Alert'
volume_mount:
$ref: '#/components/schemas/VolumeMount'
tags:
type: array
description: 'Add custom, searchable tags to instances.'
items:
$ref: '#/components/schemas/Tag'
envs:
type: array
description: 'List of environment variable name and values to automatically add to the instance'
items:
$ref: '#/components/schemas/Env'
UpdateRequest:
type: object
properties:
name:
$ref: '#/components/schemas/Name'
auto_delete:
$ref: '#/components/schemas/AutoDelete'
alert:
$ref: '#/components/schemas/Alert'
tags:
type: array
description: 'Add custom, searchable tags to instances.'
items:
$ref: '#/components/schemas/Tag'
LaunchConfiguration:
type: object
required:
- type
description: 'Defines automatic actions after the instance becomes active.'
properties:
type:
type: string
example: docker
enum:
- docker
- script
description: "Specifies the type of launch configuration. See [Launch Configuration](/getting-started/concepts#launch-configuration) for more details."
docker_configuration:
$ref: '#/components/schemas/DockerConfiguration'
script_configuration:
$ref: '#/components/schemas/ScriptConfiguration'
DockerConfiguration:
type: object
required:
- image
description: "May only be used if launch_configuration.type is 'docker'. Use docker_configuration to automatically pull and run a docker image. See this [tutorial](/guides/dockercontainers) for examples."
properties:
image:
type: string
example: vllm/vllm-openai:latest
description: 'Specifies the docker image to be pulled and run on the instance at startup.'
args:
type: string
example: --model mistralai/Mistral-7B-v0.1
description: 'Specifies the container arguments passed into the image at runtime.'
shared_memory_in_gb:
type: integer
example: 8
description: "Describes the amount of shared memory allocated for the container. Equivalent to using the --shm-size flag in the docker cli. If shared_memory_in_gb is not specified, then the container will use the host namespace which is the equivalent of --ipc=host."
envs:
type: array
description: "List of environment variable name-value pairs that will be passed to the docker container."
items:
$ref: '#/components/schemas/Env'
port_mappings:
type: array
description: "List of port mappings between the host instance and the docker container. Equivalent of -p flag for docker run command."
items:
$ref: '#/components/schemas/PortMappings'
volume_mounts:
type: array
description: "List of volume mounts between the host instance and the docker container. Equivalent of -v flag for docker run command."
items:
$ref: '#/components/schemas/VolumeMounts'
ScriptConfiguration:
type: object
required:
- base64_script
description: "May only be used if launch_configuration.type is 'script'. Configures a startup script to be run automatically after the instance is active. See this [tutorial]/guides/startupscript) for examples."
properties:
base64_script:
type: string
description: "A startup script that is base64 encoded."
example: IyEvYmluL2Jhc2gKCiMgRW5kbGVzcyBsb29wCndoaWxlIHRydWUKZG8KICAgICMgRmV0Y2ggYSBjYXQgZmFjdCB3aXRoIGEgbWF4aW11bSBsZW5ndGggb2YgMTQwIGNoYXJhY3RlcnMKICAgIGN1cmwgLS1uby1wcm9ncmVzcy1tZXRlciBodHRwczovL2NhdGZhY3QubmluamEvZmFjdD9tYXhfbGVuZ3RoPTE0MAoKICAgICMgUHJpbnQgYSBuZXdsaW5lIGZvciByZWFkYWJpbGl0eQogICAgZWNobwoKICAgICMgU2xlZXAgZm9yIDMgc2Vjb25kcyBiZWZvcmUgdGhlIG5leHQgaXRlcmF0aW9uCiAgICBzbGVlcCAzCmRvbmUKCgo=
Env:
type: object
required:
- name
- value
description: "Environment variables for the container image."
properties:
name:
type: string
example: HUGGING_FACE_HUB_TOKEN
description: "Name of the environment variable"
value:
type: string
example: hugging_face_api_token
description: "Value of the environment variable"
PortMappings:
type: object
required:
- host_port
- container_port
description: "Maps the public instance port to a port on the container."
properties:
host_port:
type: integer
example: 80
description: "Port of the host."
container_port:
type: integer
example: 8000
description: "Port of the container."
VolumeMounts:
type: object
required:
- host_path
- container_path
description: "Mounts the host volume to a container file path."
properties:
host_path:
type: string
example: "~/.cache/huggingface"
description: "Filepath of the host."
container_path:
type: string
example: "/root/.cache/huggingface"
description: "Filepath of the container."
CreateResponse:
type: object
required:
- id
- cloud_assigned_id
description: Response of the /instances/create API call
properties:
id:
$ref: '#/components/schemas/Id'
cloud_assigned_id:
$ref: '#/components/schemas/CloudAssignedId'
Cloud:
type: string
example: hyperstack
enum:
- aws
- azure
- lambdalabs
- tensordock
- runpod
- latitude
- jarvislabs
- oblivus
- paperspace
- datacrunch
- massedcompute
- vultr
description: 'Specifies the underlying cloud provider. See this [explanation](/getting-started/concepts#cloud-cloud-provider) for more details.'
Region:
type: string
example: 'canada-1'
description: 'Specifies the region.'
Id:
type: string
format: uuid
example: d290f1ee-6c54-4b01-90e6-d701748f0851
description: 'The unique identifier for the instance. Used in the instances for the /instances/{id}/info and /instances/{id}/delete APIs.'
CloudAssignedId:
type: string
example: 13b057d7-e266-4869-985f-760fe75a78b3
description: 'The unique identifier of the instance issued by the underlying cloud provider.'
Name:
type: string
example: cool-gpu-server
description: The name of the instance
ShadeInstanceType:
type: string
example: A6000
description: 'The Shadeform standardized instance type. See this [explanation](/getting-started/concepts#shade-instance-type-and-cloud-instance-type) for more details.'
ShadeCloud:
type: boolean
example: true
description: 'Specifies if the instance is launched in [Shade Cloud](/getting-started/concepts#shade-cloud) or in a linked cloud account.'
CloudInstanceType:
type: string
example: gpu_1x_a6000
description: 'The instance type for the underlying cloud provider. See this [explanation](/getting-started/concepts#shade-instance-type-and-cloud-instance-type) for more details.'
HourlyPrice:
type: integer
example: 210
description: 'The hourly price of the instance in cents.'
DeploymentType:
type: string
example: vm
description: 'Whether the instance is a "vm" (virtual machine), a "container" (docker container), or "baremetal" (bare metal server).'
Ip:
type: string
example: 1.0.0.1
description: 'The public IP address of the instance. In select cases, it may also be the DNS.'
SshUser:
type: string
example: shadeform
description: 'The SSH user used to SSH into the instance.'
SshPort:
type: integer
example: 22
description: 'The SSH port of the instance. In most cases, this will be port 22 but for some clouds, this may be a different port.'
Status:
type: string
example: active
enum:
- pending
- active
- deleted
description: 'The status of the instance.'
CostEstimate:
type: string
example: '103.4'
description: 'The cost incurred by the instance. This only the cost via Shadeform. If the instance is deployed in your own cloud account, then all billing is through your cloud provider.'
CreatedAt:
type: string
format: date-time
example: '2016-08-29T09:12:33.001Z'