-
Notifications
You must be signed in to change notification settings - Fork 20
Expand file tree
/
Copy pathgpu_droplets.py
More file actions
2858 lines (2419 loc) · 131 KB
/
gpu_droplets.py
File metadata and controls
2858 lines (2419 loc) · 131 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
# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
from __future__ import annotations
from typing import Any, Union, Optional, cast
from typing_extensions import Literal, overload
import httpx
from .sizes import (
SizesResource,
AsyncSizesResource,
SizesResourceWithRawResponse,
AsyncSizesResourceWithRawResponse,
SizesResourceWithStreamingResponse,
AsyncSizesResourceWithStreamingResponse,
)
from ...types import (
gpu_droplet_list_params,
gpu_droplet_create_params,
gpu_droplet_list_kernels_params,
gpu_droplet_delete_by_tag_params,
gpu_droplet_list_firewalls_params,
gpu_droplet_list_snapshots_params,
)
from .actions import (
ActionsResource,
AsyncActionsResource,
ActionsResourceWithRawResponse,
AsyncActionsResourceWithRawResponse,
ActionsResourceWithStreamingResponse,
AsyncActionsResourceWithStreamingResponse,
)
from .backups import (
BackupsResource,
AsyncBackupsResource,
BackupsResourceWithRawResponse,
AsyncBackupsResourceWithRawResponse,
BackupsResourceWithStreamingResponse,
AsyncBackupsResourceWithStreamingResponse,
)
from ..._types import Body, Omit, Query, Headers, NoneType, NotGiven, SequenceNotStr, omit, not_given
from ..._utils import required_args, maybe_transform, async_maybe_transform
from ..._compat import cached_property
from .autoscale import (
AutoscaleResource,
AsyncAutoscaleResource,
AutoscaleResourceWithRawResponse,
AsyncAutoscaleResourceWithRawResponse,
AutoscaleResourceWithStreamingResponse,
AsyncAutoscaleResourceWithStreamingResponse,
)
from .snapshots import (
SnapshotsResource,
AsyncSnapshotsResource,
SnapshotsResourceWithRawResponse,
AsyncSnapshotsResourceWithRawResponse,
SnapshotsResourceWithStreamingResponse,
AsyncSnapshotsResourceWithStreamingResponse,
)
from ..._resource import SyncAPIResource, AsyncAPIResource
from ..._response import (
to_raw_response_wrapper,
to_streamed_response_wrapper,
async_to_raw_response_wrapper,
async_to_streamed_response_wrapper,
)
from .images.images import (
ImagesResource,
AsyncImagesResource,
ImagesResourceWithRawResponse,
AsyncImagesResourceWithRawResponse,
ImagesResourceWithStreamingResponse,
AsyncImagesResourceWithStreamingResponse,
)
from ..._base_client import make_request_options
from .account.account import (
AccountResource,
AsyncAccountResource,
AccountResourceWithRawResponse,
AsyncAccountResourceWithRawResponse,
AccountResourceWithStreamingResponse,
AsyncAccountResourceWithStreamingResponse,
)
from .volumes.volumes import (
VolumesResource,
AsyncVolumesResource,
VolumesResourceWithRawResponse,
AsyncVolumesResourceWithRawResponse,
VolumesResourceWithStreamingResponse,
AsyncVolumesResourceWithStreamingResponse,
)
from .firewalls.firewalls import (
FirewallsResource,
AsyncFirewallsResource,
FirewallsResourceWithRawResponse,
AsyncFirewallsResourceWithRawResponse,
FirewallsResourceWithStreamingResponse,
AsyncFirewallsResourceWithStreamingResponse,
)
from .floating_ips.floating_ips import (
FloatingIPsResource,
AsyncFloatingIPsResource,
FloatingIPsResourceWithRawResponse,
AsyncFloatingIPsResourceWithRawResponse,
FloatingIPsResourceWithStreamingResponse,
AsyncFloatingIPsResourceWithStreamingResponse,
)
from .load_balancers.load_balancers import (
LoadBalancersResource,
AsyncLoadBalancersResource,
LoadBalancersResourceWithRawResponse,
AsyncLoadBalancersResourceWithRawResponse,
LoadBalancersResourceWithStreamingResponse,
AsyncLoadBalancersResourceWithStreamingResponse,
)
from ...types.gpu_droplet_list_response import GPUDropletListResponse
from .destroy_with_associated_resources import (
DestroyWithAssociatedResourcesResource,
AsyncDestroyWithAssociatedResourcesResource,
DestroyWithAssociatedResourcesResourceWithRawResponse,
AsyncDestroyWithAssociatedResourcesResourceWithRawResponse,
DestroyWithAssociatedResourcesResourceWithStreamingResponse,
AsyncDestroyWithAssociatedResourcesResourceWithStreamingResponse,
)
from ...types.droplet_backup_policy_param import DropletBackupPolicyParam
from ...types.gpu_droplet_create_response import GPUDropletCreateResponse
from ...types.gpu_droplet_retrieve_response import GPUDropletRetrieveResponse
from ...types.gpu_droplet_list_kernels_response import GPUDropletListKernelsResponse
from ...types.gpu_droplet_list_firewalls_response import GPUDropletListFirewallsResponse
from ...types.gpu_droplet_list_neighbors_response import GPUDropletListNeighborsResponse
from ...types.gpu_droplet_list_snapshots_response import GPUDropletListSnapshotsResponse
__all__ = ["GPUDropletsResource", "AsyncGPUDropletsResource"]
class GPUDropletsResource(SyncAPIResource):
"""
A [Droplet](https://docs.digitalocean.com/products/droplets/) is a DigitalOcean
virtual machine. By sending requests to the Droplet endpoint, you can
list, create, or delete Droplets.
Some of the attributes will have an object value. The `region` and `image`
objects will all contain the standard attributes of their associated
types. Find more information about each of these objects in their
respective sections.
"""
@cached_property
def backups(self) -> BackupsResource:
"""
A [Droplet](https://docs.digitalocean.com/products/droplets/) is a DigitalOcean
virtual machine. By sending requests to the Droplet endpoint, you can
list, create, or delete Droplets.
Some of the attributes will have an object value. The `region` and `image`
objects will all contain the standard attributes of their associated
types. Find more information about each of these objects in their
respective sections.
"""
return BackupsResource(self._client)
@cached_property
def actions(self) -> ActionsResource:
"""Droplet actions are tasks that can be executed on a Droplet.
These can be
things like rebooting, resizing, snapshotting, etc.
Droplet action requests are generally targeted at one of the "actions"
endpoints for a specific Droplet. The specific actions are usually
initiated by sending a POST request with the action and arguments as
parameters.
Droplet action requests create a Droplet actions object, which can be used
to get information about the status of an action. Creating a Droplet
action is asynchronous: the HTTP call will return the action object before
the action has finished processing on the Droplet. The current status of
an action can be retrieved from either the Droplet actions endpoint or the
global actions endpoint. If a Droplet action is uncompleted it may block
the creation of a subsequent action for that Droplet, the locked attribute
of the Droplet will be true and attempts to create a Droplet action will
fail with a status of 422.
"""
return ActionsResource(self._client)
@cached_property
def destroy_with_associated_resources(self) -> DestroyWithAssociatedResourcesResource:
"""
A [Droplet](https://docs.digitalocean.com/products/droplets/) is a DigitalOcean
virtual machine. By sending requests to the Droplet endpoint, you can
list, create, or delete Droplets.
Some of the attributes will have an object value. The `region` and `image`
objects will all contain the standard attributes of their associated
types. Find more information about each of these objects in their
respective sections.
"""
return DestroyWithAssociatedResourcesResource(self._client)
@cached_property
def autoscale(self) -> AutoscaleResource:
"""
Droplet autoscale pools manage automatic horizontal scaling for your applications based on resource usage (CPU, memory, or both) or a static configuration.
"""
return AutoscaleResource(self._client)
@cached_property
def firewalls(self) -> FirewallsResource:
"""
[DigitalOcean Cloud Firewalls](https://docs.digitalocean.com/products/networking/firewalls/)
provide the ability to restrict network access to and from a Droplet
allowing you to define which ports will accept inbound or outbound
connections. By sending requests to the `/v2/firewalls` endpoint, you can
list, create, or delete firewalls as well as modify access rules.
"""
return FirewallsResource(self._client)
@cached_property
def floating_ips(self) -> FloatingIPsResource:
"""
As of 16 June 2022, we have renamed the Floating IP product to [Reserved IPs](https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPs).
The Reserved IP product's endpoints function the exact same way as Floating IPs.
The only difference is the name change throughout the URLs and fields.
For example, the `floating_ips` field is now the `reserved_ips` field.
The Floating IP endpoints will remain active until fall 2023 before being
permanently deprecated.
With the exception of the [Projects API](https://docs.digitalocean.com/reference/api/api-reference/#tag/Projects),
we will reflect this change as an additional field in the responses across the API
where the `floating_ip` field is used. For example, the Droplet metadata response
will contain the field `reserved_ips` in addition to the `floating_ips` field.
Floating IPs retrieved using the Projects API will retain the original name.
[DigitalOcean Floating IPs](https://docs.digitalocean.com/products/networking/reserved-ips/)
are publicly-accessible static IP addresses that can be mapped to one of
your Droplets. They can be used to create highly available setups or other
configurations requiring movable addresses.
Floating IPs are bound to a specific region.
"""
return FloatingIPsResource(self._client)
@cached_property
def images(self) -> ImagesResource:
"""
A DigitalOcean [image](https://docs.digitalocean.com/products/images/) can be
used to create a Droplet and may come in a number of flavors. Currently,
there are five types of images: snapshots, backups, applications,
distributions, and custom images.
* [Snapshots](https://docs.digitalocean.com/products/snapshots/) provide
a full copy of an existing Droplet instance taken on demand.
* [Backups](https://docs.digitalocean.com/products/backups/) are similar
to snapshots but are created automatically at regular intervals when
enabled for a Droplet.
* [Custom images](https://docs.digitalocean.com/products/custom-images/)
are Linux-based virtual machine images (raw, qcow2, vhdx, vdi, and vmdk
formats are supported) that you may upload for use on DigitalOcean.
* Distributions are the public Linux distributions that are available to
be used as a base to create Droplets.
* Applications, or [1-Click Apps](https://docs.digitalocean.com/products/marketplace/),
are distributions pre-configured with additional software.
To interact with images, you will generally send requests to the images
endpoint at /v2/images.
"""
return ImagesResource(self._client)
@cached_property
def load_balancers(self) -> LoadBalancersResource:
"""
[DigitalOcean Load Balancers](https://docs.digitalocean.com/products/networking/load-balancers/)
provide a way to distribute traffic across multiple Droplets. By sending
requests to the `/v2/load_balancers` endpoint, you can list, create, or
delete load balancers as well as add or remove Droplets, forwarding rules,
and other configuration details.
"""
return LoadBalancersResource(self._client)
@cached_property
def sizes(self) -> SizesResource:
"""
The sizes objects represent different packages of hardware resources that
can be used for Droplets. When a Droplet is created, a size must be
selected so that the correct resources can be allocated.
Each size represents a plan that bundles together specific sets of
resources. This includes the amount of RAM, the number of virtual CPUs,
disk space, and transfer. The size object also includes the pricing
details and the regions that the size is available in.
"""
return SizesResource(self._client)
@cached_property
def snapshots(self) -> SnapshotsResource:
"""
[Snapshots](https://docs.digitalocean.com/products/snapshots/) are saved
instances of a Droplet or a block storage volume, which is reflected in
the `resource_type` attribute. In order to avoid problems with compressing
filesystems, each defines a `min_disk_size` attribute which is the minimum
size of the Droplet or volume disk when creating a new resource from the
saved snapshot.
To interact with snapshots, you will generally send requests to the
snapshots endpoint at `/v2/snapshots`.
"""
return SnapshotsResource(self._client)
@cached_property
def volumes(self) -> VolumesResource:
"""
[DigitalOcean Block Storage Volumes](https://docs.digitalocean.com/products/volumes/)
provide expanded storage capacity for your Droplets and can be moved
between Droplets within a specific region.
Volumes function as raw block devices, meaning they appear to the
operating system as locally attached storage which can be formatted using
any file system supported by the OS. They may be created in sizes from
1GiB to 16TiB.
By sending requests to the `/v2/volumes` endpoint, you can list, create, or
delete volumes as well as attach and detach them from Droplets
"""
return VolumesResource(self._client)
@cached_property
def account(self) -> AccountResource:
return AccountResource(self._client)
@cached_property
def with_raw_response(self) -> GPUDropletsResourceWithRawResponse:
"""
This property can be used as a prefix for any HTTP method call to return
the raw response object instead of the parsed content.
For more information, see https://www.github.com/digitalocean/gradient-python#accessing-raw-response-data-eg-headers
"""
return GPUDropletsResourceWithRawResponse(self)
@cached_property
def with_streaming_response(self) -> GPUDropletsResourceWithStreamingResponse:
"""
An alternative to `.with_raw_response` that doesn't eagerly read the response body.
For more information, see https://www.github.com/digitalocean/gradient-python#with_streaming_response
"""
return GPUDropletsResourceWithStreamingResponse(self)
@overload
def create(
self,
*,
image: Union[str, int],
name: str,
size: str,
backup_policy: DropletBackupPolicyParam | Omit = omit,
backups: bool | Omit = omit,
ipv6: bool | Omit = omit,
monitoring: bool | Omit = omit,
private_networking: bool | Omit = omit,
region: str | Omit = omit,
ssh_keys: SequenceNotStr[Union[str, int]] | Omit = omit,
tags: Optional[SequenceNotStr[str]] | Omit = omit,
user_data: str | Omit = omit,
volumes: SequenceNotStr[str] | Omit = omit,
vpc_uuid: str | Omit = omit,
with_droplet_agent: bool | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletCreateResponse:
"""
To create a new Droplet, send a POST request to `/v2/droplets` setting the
required attributes.
A Droplet will be created using the provided information. The response body will
contain a JSON object with a key called `droplet`. The value will be an object
containing the standard attributes for your new Droplet. The response code, 202
Accepted, does not indicate the success or failure of the operation, just that
the request has been accepted for processing. The `actions` returned as part of
the response's `links` object can be used to check the status of the Droplet
create event.
### Create Multiple Droplets
Creating multiple Droplets is very similar to creating a single Droplet. Instead
of sending `name` as a string, send `names` as an array of strings. A Droplet
will be created for each name you send using the associated information. Up to
ten Droplets may be created this way at a time.
Rather than returning a single Droplet, the response body will contain a JSON
array with a key called `droplets`. This will be set to an array of JSON
objects, each of which will contain the standard Droplet attributes. The
response code, 202 Accepted, does not indicate the success or failure of any
operation, just that the request has been accepted for processing. The array of
`actions` returned as part of the response's `links` object can be used to check
the status of each individual Droplet create event.
Args:
image: The image ID of a public or private image or the slug identifier for a public
image. This image will be the base image for your Droplet. Requires `image:read`
scope.
name: The human-readable string you wish to use when displaying the Droplet name. The
name, if set to a domain name managed in the DigitalOcean DNS management system,
will configure a PTR record for the Droplet. The name set during creation will
also determine the hostname for the Droplet in its internal configuration.
size: The slug identifier for the size that you wish to select for this Droplet.
backup_policy: An object specifying the backup policy for the Droplet. If omitted and `backups`
is `true`, the backup plan will default to daily.
backups: A boolean indicating whether automated backups should be enabled for the
Droplet.
ipv6: A boolean indicating whether to enable IPv6 on the Droplet.
monitoring: A boolean indicating whether to install the DigitalOcean agent for monitoring.
private_networking: This parameter has been deprecated. Use `vpc_uuid` instead to specify a VPC
network for the Droplet. If no `vpc_uuid` is provided, the Droplet will be
placed in your account's default VPC for the region.
region: The slug identifier for the region that you wish to deploy the Droplet in. If
the specific datacenter is not not important, a slug prefix (e.g. `nyc`) can be
used to deploy the Droplet in any of the that region's locations (`nyc1`,
`nyc2`, or `nyc3`). If the region is omitted from the create request completely,
the Droplet may deploy in any region.
ssh_keys: An array containing the IDs or fingerprints of the SSH keys that you wish to
embed in the Droplet's root account upon creation. You must add the keys to your
team before they can be embedded on a Droplet. Requires `ssh_key:read` scope.
tags: A flat array of tag names as strings to apply to the Droplet after it is
created. Tag names can either be existing or new tags. Requires `tag:create`
scope.
user_data: A string containing 'user data' which may be used to configure the Droplet on
first boot, often a 'cloud-config' file or Bash script. It must be plain text
and may not exceed 64 KiB in size.
volumes: An array of IDs for block storage volumes that will be attached to the Droplet
once created. The volumes must not already be attached to an existing Droplet.
Requires `block_storage:read` scpoe.
vpc_uuid: A string specifying the UUID of the VPC to which the Droplet will be assigned.
If excluded, the Droplet will be assigned to your account's default VPC for the
region. Requires `vpc:read` scope.
with_droplet_agent: A boolean indicating whether to install the DigitalOcean agent used for
providing access to the Droplet web console in the control panel. By default,
the agent is installed on new Droplets but installation errors (i.e. OS not
supported) are ignored. To prevent it from being installed, set to `false`. To
make installation errors fatal, explicitly set it to `true`.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@overload
def create(
self,
*,
image: Union[str, int],
names: SequenceNotStr[str],
size: str,
backup_policy: DropletBackupPolicyParam | Omit = omit,
backups: bool | Omit = omit,
ipv6: bool | Omit = omit,
monitoring: bool | Omit = omit,
private_networking: bool | Omit = omit,
region: str | Omit = omit,
ssh_keys: SequenceNotStr[Union[str, int]] | Omit = omit,
tags: Optional[SequenceNotStr[str]] | Omit = omit,
user_data: str | Omit = omit,
volumes: SequenceNotStr[str] | Omit = omit,
vpc_uuid: str | Omit = omit,
with_droplet_agent: bool | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletCreateResponse:
"""
To create a new Droplet, send a POST request to `/v2/droplets` setting the
required attributes.
A Droplet will be created using the provided information. The response body will
contain a JSON object with a key called `droplet`. The value will be an object
containing the standard attributes for your new Droplet. The response code, 202
Accepted, does not indicate the success or failure of the operation, just that
the request has been accepted for processing. The `actions` returned as part of
the response's `links` object can be used to check the status of the Droplet
create event.
### Create Multiple Droplets
Creating multiple Droplets is very similar to creating a single Droplet. Instead
of sending `name` as a string, send `names` as an array of strings. A Droplet
will be created for each name you send using the associated information. Up to
ten Droplets may be created this way at a time.
Rather than returning a single Droplet, the response body will contain a JSON
array with a key called `droplets`. This will be set to an array of JSON
objects, each of which will contain the standard Droplet attributes. The
response code, 202 Accepted, does not indicate the success or failure of any
operation, just that the request has been accepted for processing. The array of
`actions` returned as part of the response's `links` object can be used to check
the status of each individual Droplet create event.
Args:
image: The image ID of a public or private image or the slug identifier for a public
image. This image will be the base image for your Droplet. Requires `image:read`
scope.
names: An array of human human-readable strings you wish to use when displaying the
Droplet name. Each name, if set to a domain name managed in the DigitalOcean DNS
management system, will configure a PTR record for the Droplet. Each name set
during creation will also determine the hostname for the Droplet in its internal
configuration.
size: The slug identifier for the size that you wish to select for this Droplet.
backup_policy: An object specifying the backup policy for the Droplet. If omitted and `backups`
is `true`, the backup plan will default to daily.
backups: A boolean indicating whether automated backups should be enabled for the
Droplet.
ipv6: A boolean indicating whether to enable IPv6 on the Droplet.
monitoring: A boolean indicating whether to install the DigitalOcean agent for monitoring.
private_networking: This parameter has been deprecated. Use `vpc_uuid` instead to specify a VPC
network for the Droplet. If no `vpc_uuid` is provided, the Droplet will be
placed in your account's default VPC for the region.
region: The slug identifier for the region that you wish to deploy the Droplet in. If
the specific datacenter is not not important, a slug prefix (e.g. `nyc`) can be
used to deploy the Droplet in any of the that region's locations (`nyc1`,
`nyc2`, or `nyc3`). If the region is omitted from the create request completely,
the Droplet may deploy in any region.
ssh_keys: An array containing the IDs or fingerprints of the SSH keys that you wish to
embed in the Droplet's root account upon creation. You must add the keys to your
team before they can be embedded on a Droplet. Requires `ssh_key:read` scope.
tags: A flat array of tag names as strings to apply to the Droplet after it is
created. Tag names can either be existing or new tags. Requires `tag:create`
scope.
user_data: A string containing 'user data' which may be used to configure the Droplet on
first boot, often a 'cloud-config' file or Bash script. It must be plain text
and may not exceed 64 KiB in size.
volumes: An array of IDs for block storage volumes that will be attached to the Droplet
once created. The volumes must not already be attached to an existing Droplet.
Requires `block_storage:read` scpoe.
vpc_uuid: A string specifying the UUID of the VPC to which the Droplet will be assigned.
If excluded, the Droplet will be assigned to your account's default VPC for the
region. Requires `vpc:read` scope.
with_droplet_agent: A boolean indicating whether to install the DigitalOcean agent used for
providing access to the Droplet web console in the control panel. By default,
the agent is installed on new Droplets but installation errors (i.e. OS not
supported) are ignored. To prevent it from being installed, set to `false`. To
make installation errors fatal, explicitly set it to `true`.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
...
@required_args(["image", "name", "size"], ["image", "names", "size"])
def create(
self,
*,
image: Union[str, int],
name: str | Omit = omit,
size: str,
backup_policy: DropletBackupPolicyParam | Omit = omit,
backups: bool | Omit = omit,
ipv6: bool | Omit = omit,
monitoring: bool | Omit = omit,
private_networking: bool | Omit = omit,
region: str | Omit = omit,
ssh_keys: SequenceNotStr[Union[str, int]] | Omit = omit,
tags: Optional[SequenceNotStr[str]] | Omit = omit,
user_data: str | Omit = omit,
volumes: SequenceNotStr[str] | Omit = omit,
vpc_uuid: str | Omit = omit,
with_droplet_agent: bool | Omit = omit,
names: SequenceNotStr[str] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletCreateResponse:
return cast(
GPUDropletCreateResponse,
self._post(
"/v2/droplets" if self._client._base_url_overridden else "https://api.digitalocean.com/v2/droplets",
body=maybe_transform(
{
"image": image,
"name": name,
"size": size,
"backup_policy": backup_policy,
"backups": backups,
"ipv6": ipv6,
"monitoring": monitoring,
"private_networking": private_networking,
"region": region,
"ssh_keys": ssh_keys,
"tags": tags,
"user_data": user_data,
"volumes": volumes,
"vpc_uuid": vpc_uuid,
"with_droplet_agent": with_droplet_agent,
"names": names,
},
gpu_droplet_create_params.GPUDropletCreateParams,
),
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=cast(
Any, GPUDropletCreateResponse
), # Union types cannot be passed in as arguments in the type system
),
)
def retrieve(
self,
droplet_id: int,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletRetrieveResponse:
"""
To show information about an individual Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID`.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
f"/v2/droplets/{droplet_id}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/droplets/{droplet_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=GPUDropletRetrieveResponse,
)
def list(
self,
*,
name: str | Omit = omit,
page: int | Omit = omit,
per_page: int | Omit = omit,
tag_name: str | Omit = omit,
type: Literal["droplets", "gpus"] | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletListResponse:
"""
To list all Droplets in your account, send a GET request to `/v2/droplets`.
The response body will be a JSON object with a key of `droplets`. This will be
set to an array containing objects each representing a Droplet. These will
contain the standard Droplet attributes.
### Filtering Results by Tag
It's possible to request filtered results by including certain query parameters.
To only list Droplets assigned to a specific tag, include the `tag_name` query
parameter set to the name of the tag in your GET request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
### GPU Droplets
By default, only non-GPU Droplets are returned. To list only GPU Droplets, set
the `type` query parameter to `gpus`. For example, `/v2/droplets?type=gpus`.
Args:
name: Used to filter list response by Droplet name returning only exact matches. It is
case-insensitive and can not be combined with `tag_name`.
page: Which 'page' of paginated results to return.
per_page: Number of items returned per page
tag_name: Used to filter Droplets by a specific tag. Can not be combined with `name` or
`type`. Requires `tag:read` scope.
type: When `type` is set to `gpus`, only GPU Droplets will be returned. By default,
only non-GPU Droplets are returned. Can not be combined with `tag_name`.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
"/v2/droplets" if self._client._base_url_overridden else "https://api.digitalocean.com/v2/droplets",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"name": name,
"page": page,
"per_page": per_page,
"tag_name": tag_name,
"type": type,
},
gpu_droplet_list_params.GPUDropletListParams,
),
),
cast_to=GPUDropletListResponse,
)
def delete(
self,
droplet_id: int,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> None:
"""
To delete a Droplet, send a DELETE request to `/v2/droplets/$DROPLET_ID`.
A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
return self._delete(
f"/v2/droplets/{droplet_id}"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/droplets/{droplet_id}",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=NoneType,
)
def delete_by_tag(
self,
*,
tag_name: str,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> None:
"""
To delete **all** Droplets assigned to a specific tag, include the `tag_name`
query parameter set to the name of the tag in your DELETE request. For example,
`/v2/droplets?tag_name=$TAG_NAME`.
This endpoint requires `tag:read` scope.
A successful request will receive a 204 status code with no body in response.
This indicates that the request was processed successfully.
Args:
tag_name: Specifies Droplets to be deleted by tag.
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
extra_headers = {"Accept": "*/*", **(extra_headers or {})}
return self._delete(
"/v2/droplets" if self._client._base_url_overridden else "https://api.digitalocean.com/v2/droplets",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{"tag_name": tag_name}, gpu_droplet_delete_by_tag_params.GPUDropletDeleteByTagParams
),
),
cast_to=NoneType,
)
def list_firewalls(
self,
droplet_id: int,
*,
page: int | Omit = omit,
per_page: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletListFirewallsResponse:
"""
To retrieve a list of all firewalls available to a Droplet, send a GET request
to `/v2/droplets/$DROPLET_ID/firewalls`
The response will be a JSON object that has a key called `firewalls`. This will
be set to an array of `firewall` objects, each of which contain the standard
`firewall` attributes.
Args:
page: Which 'page' of paginated results to return.
per_page: Number of items returned per page
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
f"/v2/droplets/{droplet_id}/firewalls"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/droplets/{droplet_id}/firewalls",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"page": page,
"per_page": per_page,
},
gpu_droplet_list_firewalls_params.GPUDropletListFirewallsParams,
),
),
cast_to=GPUDropletListFirewallsResponse,
)
def list_kernels(
self,
droplet_id: int,
*,
page: int | Omit = omit,
per_page: int | Omit = omit,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletListKernelsResponse:
"""
To retrieve a list of all kernels available to a Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID/kernels`
The response will be a JSON object that has a key called `kernels`. This will be
set to an array of `kernel` objects, each of which contain the standard `kernel`
attributes.
Args:
page: Which 'page' of paginated results to return.
per_page: Number of items returned per page
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
f"/v2/droplets/{droplet_id}/kernels"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/droplets/{droplet_id}/kernels",
options=make_request_options(
extra_headers=extra_headers,
extra_query=extra_query,
extra_body=extra_body,
timeout=timeout,
query=maybe_transform(
{
"page": page,
"per_page": per_page,
},
gpu_droplet_list_kernels_params.GPUDropletListKernelsParams,
),
),
cast_to=GPUDropletListKernelsResponse,
)
def list_neighbors(
self,
droplet_id: int,
*,
# Use the following arguments if you need to pass additional parameters to the API that aren't available via kwargs.
# The extra values given here take precedence over values defined on the client or passed to this method.
extra_headers: Headers | None = None,
extra_query: Query | None = None,
extra_body: Body | None = None,
timeout: float | httpx.Timeout | None | NotGiven = not_given,
) -> GPUDropletListNeighborsResponse:
"""To retrieve a list of any "neighbors" (i.e.
Droplets that are co-located on the
same physical hardware) for a specific Droplet, send a GET request to
`/v2/droplets/$DROPLET_ID/neighbors`.
The results will be returned as a JSON object with a key of `droplets`. This
will be set to an array containing objects representing any other Droplets that
share the same physical hardware. An empty array indicates that the Droplet is
not co-located any other Droplets associated with your account.
Args:
extra_headers: Send extra headers
extra_query: Add additional query parameters to the request
extra_body: Add additional JSON properties to the request
timeout: Override the client-level default timeout for this request, in seconds
"""
return self._get(
f"/v2/droplets/{droplet_id}/neighbors"
if self._client._base_url_overridden
else f"https://api.digitalocean.com/v2/droplets/{droplet_id}/neighbors",
options=make_request_options(
extra_headers=extra_headers, extra_query=extra_query, extra_body=extra_body, timeout=timeout
),
cast_to=GPUDropletListNeighborsResponse,
)