## Create `client.gpuDroplets.create(GPUDropletCreateParamsbody, RequestOptionsoptions?): GPUDropletCreateResponse` **post** `/v2/droplets` 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. ### Parameters - `GPUDropletCreateParams = DropletSingleCreate | DropletMultiCreate` - `GPUDropletCreateParamsBase` - `image: string | number` 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. - `string` - `number` - `name: string` 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: string` The slug identifier for the size that you wish to select for this Droplet. - `backup_policy?: DropletBackupPolicy` An object specifying the backup policy for the Droplet. If omitted and `backups` is `true`, the backup plan will default to daily. - `hour?: 0 | 4 | 8 | 3 more` The hour of the day that the backup window will start. - `0` - `4` - `8` - `12` - `16` - `20` - `plan?: "daily" | "weekly"` The backup plan used for the Droplet. The plan can be either `daily` or `weekly`. - `"daily"` - `"weekly"` - `retention_period_days?: number` The number of days the backup will be retained. - `weekday?: "SUN" | "MON" | "TUE" | 4 more` The day of the week on which the backup will occur. - `"SUN"` - `"MON"` - `"TUE"` - `"WED"` - `"THU"` - `"FRI"` - `"SAT"` - `window_length_hours?: number` The length of the backup window starting from `hour`. - `backups?: boolean` A boolean indicating whether automated backups should be enabled for the Droplet. - `ipv6?: boolean` A boolean indicating whether to enable IPv6 on the Droplet. - `monitoring?: boolean` A boolean indicating whether to install the DigitalOcean agent for monitoring. - `private_networking?: boolean` 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?: string` 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?: Array` 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. - `string` - `number` - `tags?: Array | null` 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?: string` 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?: Array` 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?: string` 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?: boolean` 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`. - `DropletSingleCreate extends GPUDropletCreateParamsBase` - `DropletMultiCreate extends GPUDropletCreateParamsBase` ### Returns - `GPUDropletCreateResponse = SingleDropletResponse | MultipleDropletResponse` - `SingleDropletResponse` - `droplet: Droplet` - `id: number` A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. - `backup_ids: Array` An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
Requires `image:read` scope. - `created_at: string` A time value given in ISO8601 combined date and time format that represents when the Droplet was created. - `disk: number` The size of the Droplet's disk in gigabytes. - `features: Array` An array of features enabled on this Droplet. - `image: Image` The Droplet's image.
Requires `image:read` scope. - `id?: number` A unique number that can be used to identify and reference a specific image. - `created_at?: string` A time value given in ISO8601 combined date and time format that represents when the image was created. - `description?: string` An optional free-form text field to describe an image. - `distribution?: "Arch Linux" | "CentOS" | "CoreOS" | 10 more` The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place. - `"Arch Linux"` - `"CentOS"` - `"CoreOS"` - `"Debian"` - `"Fedora"` - `"Fedora Atomic"` - `"FreeBSD"` - `"Gentoo"` - `"openSUSE"` - `"RancherOS"` - `"Rocky Linux"` - `"Ubuntu"` - `"Unknown"` - `error_message?: string` A string containing information about errors that may occur when importing a custom image. - `min_disk_size?: number | null` The minimum disk size in GB required for a Droplet to use this image. - `name?: string` The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. - `public?: boolean` This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account. - `regions?: Array<"ams1" | "ams2" | "ams3" | 12 more>` This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values. - `"ams1"` - `"ams2"` - `"ams3"` - `"blr1"` - `"fra1"` - `"lon1"` - `"nyc1"` - `"nyc2"` - `"nyc3"` - `"sfo1"` - `"sfo2"` - `"sfo3"` - `"sgp1"` - `"tor1"` - `"syd1"` - `size_gigabytes?: number | null` The size of the image in gigabytes. - `slug?: string | null` A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id. - `status?: "NEW" | "available" | "pending" | 2 more` A status string indicating the state of a custom image. This may be `NEW`, `available`, `pending`, `deleted`, or `retired`. - `"NEW"` - `"available"` - `"pending"` - `"deleted"` - `"retired"` - `tags?: Array | null` A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires `tag:create` scope. - `type?: "base" | "snapshot" | "backup" | 2 more` Describes the kind of image. It may be one of `base`, `snapshot`, `backup`, `custom`, or `admin`. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes). - `"base"` - `"snapshot"` - `"backup"` - `"custom"` - `"admin"` - `locked: boolean` A boolean value indicating whether the Droplet has been locked, preventing actions by users. - `memory: number` Memory of the Droplet in megabytes. - `name: string` The human-readable name set for the Droplet instance. - `networks: Networks` The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. - `v4?: Array` - `gateway?: string` The gateway of the specified IPv4 network interface. For private interfaces, a gateway is not provided. This is denoted by returning `nil` as its value. - `ip_address?: string` The IP address of the IPv4 network interface. - `netmask?: string` The netmask of the IPv4 network interface. - `type?: "public" | "private"` The type of the IPv4 network interface. - `"public"` - `"private"` - `v6?: Array` - `gateway?: string` The gateway of the specified IPv6 network interface. - `ip_address?: string` The IP address of the IPv6 network interface. - `netmask?: number` The netmask of the IPv6 network interface. - `type?: "public"` The type of the IPv6 network interface. **Note**: IPv6 private networking is not currently supported. - `"public"` - `next_backup_window: DropletNextBackupWindow | null` The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. - `end?: string` A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window. - `start?: string` A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window. - `region: Region` - `available: boolean` This is a boolean value that represents whether new Droplets can be created in this region. - `features: Array` This attribute is set to an array which contains features available in this region - `name: string` The display name of the region. This will be a full name that is used in the control panel and other interfaces. - `sizes: Array` This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view. - `slug: string` A human-readable string that is used as a unique identifier for each region. - `size: Size` - `available: boolean` This is a boolean value that represents whether new Droplets can be created with this size. - `description: string` A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized. - `disk: number` The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes. - `memory: number` The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes. - `price_hourly: number` This describes the price of the Droplet size as measured hourly. The value is measured in US dollars. - `price_monthly: number` This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars. - `regions: Array` An array containing the region slugs where this size is available for Droplet creates. - `slug: string` A human-readable string that is used to uniquely identify each size. - `transfer: number` The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes. - `vcpus: number` The number of CPUs allocated to Droplets of this size. - `disk_info?: Array` An array of objects containing information about the disks available to Droplets created with this size. - `size?: Size` - `amount?: number` The amount of space allocated to the disk. - `unit?: string` The unit of measure for the disk size. - `type?: "local" | "scratch"` The type of disk. All Droplets contain a `local` disk. Additionally, GPU Droplets can also have a `scratch` disk for non-persistent data. - `"local"` - `"scratch"` - `gpu_info?: GPUInfo` An object containing information about the GPU capabilities of Droplets created with this size. - `count?: number` The number of GPUs allocated to the Droplet. - `model?: string` The model of the GPU. - `vram?: Vram` - `amount?: number` The amount of VRAM allocated to the GPU. - `unit?: string` The unit of measure for the VRAM. - `size_slug: string` The unique slug identifier for the size of this Droplet. - `snapshot_ids: Array` An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires `image:read` scope. - `status: "new" | "active" | "off" | "archive"` A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". - `"new"` - `"active"` - `"off"` - `"archive"` - `tags: Array` An array of Tags the Droplet has been tagged with.
Requires `tag:read` scope. - `vcpus: number` The number of virtual CPUs. - `volume_ids: Array` A flat array including the unique identifier for each Block Storage volume attached to the Droplet.
Requires `block_storage:read` scope. - `disk_info?: Array` An array of objects containing information about the disks available to the Droplet. - `size?: Size` - `amount?: number` The amount of space allocated to the disk. - `unit?: string` The unit of measure for the disk size. - `type?: "local" | "scratch"` The type of disk. All Droplets contain a `local` disk. Additionally, GPU Droplets can also have a `scratch` disk for non-persistent data. - `"local"` - `"scratch"` - `gpu_info?: GPUInfo` An object containing information about the GPU capabilities of Droplets created with this size. - `count?: number` The number of GPUs allocated to the Droplet. - `model?: string` The model of the GPU. - `vram?: Vram` - `amount?: number` The amount of VRAM allocated to the GPU. - `unit?: string` The unit of measure for the VRAM. - `kernel?: Kernel | null` **Note**: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to `null`. The current [kernel](https://docs.digitalocean.com/products/droplets/how-to/kernel/) for Droplets with externally managed kernels. This will initially be set to the kernel of the base image when the Droplet is created. - `id?: number` A unique number used to identify and reference a specific kernel. - `name?: string` The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question. - `version?: string` A standard kernel version string representing the version, patch, and release information. - `vpc_uuid?: string` A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires `vpc:read` scope. - `links: Links` - `actions?: Array` - `id?: number` A unique numeric ID that can be used to identify and reference an action. - `href?: string` A URL that can be used to access the action. - `rel?: string` A string specifying the type of the related action. - `MultipleDropletResponse` - `droplets: Array` - `id: number` A unique identifier for each Droplet instance. This is automatically generated upon Droplet creation. - `backup_ids: Array` An array of backup IDs of any backups that have been taken of the Droplet instance. Droplet backups are enabled at the time of the instance creation.
Requires `image:read` scope. - `created_at: string` A time value given in ISO8601 combined date and time format that represents when the Droplet was created. - `disk: number` The size of the Droplet's disk in gigabytes. - `features: Array` An array of features enabled on this Droplet. - `image: Image` The Droplet's image.
Requires `image:read` scope. - `id?: number` A unique number that can be used to identify and reference a specific image. - `created_at?: string` A time value given in ISO8601 combined date and time format that represents when the image was created. - `description?: string` An optional free-form text field to describe an image. - `distribution?: "Arch Linux" | "CentOS" | "CoreOS" | 10 more` The name of a custom image's distribution. Currently, the valid values are `Arch Linux`, `CentOS`, `CoreOS`, `Debian`, `Fedora`, `Fedora Atomic`, `FreeBSD`, `Gentoo`, `openSUSE`, `RancherOS`, `Rocky Linux`, `Ubuntu`, and `Unknown`. Any other value will be accepted but ignored, and `Unknown` will be used in its place. - `"Arch Linux"` - `"CentOS"` - `"CoreOS"` - `"Debian"` - `"Fedora"` - `"Fedora Atomic"` - `"FreeBSD"` - `"Gentoo"` - `"openSUSE"` - `"RancherOS"` - `"Rocky Linux"` - `"Ubuntu"` - `"Unknown"` - `error_message?: string` A string containing information about errors that may occur when importing a custom image. - `min_disk_size?: number | null` The minimum disk size in GB required for a Droplet to use this image. - `name?: string` The display name that has been given to an image. This is what is shown in the control panel and is generally a descriptive title for the image in question. - `public?: boolean` This is a boolean value that indicates whether the image in question is public or not. An image that is public is available to all accounts. A non-public image is only accessible from your account. - `regions?: Array<"ams1" | "ams2" | "ams3" | 12 more>` This attribute is an array of the regions that the image is available in. The regions are represented by their identifying slug values. - `"ams1"` - `"ams2"` - `"ams3"` - `"blr1"` - `"fra1"` - `"lon1"` - `"nyc1"` - `"nyc2"` - `"nyc3"` - `"sfo1"` - `"sfo2"` - `"sfo3"` - `"sgp1"` - `"tor1"` - `"syd1"` - `size_gigabytes?: number | null` The size of the image in gigabytes. - `slug?: string | null` A uniquely identifying string that is associated with each of the DigitalOcean-provided public images. These can be used to reference a public image as an alternative to the numeric id. - `status?: "NEW" | "available" | "pending" | 2 more` A status string indicating the state of a custom image. This may be `NEW`, `available`, `pending`, `deleted`, or `retired`. - `"NEW"` - `"available"` - `"pending"` - `"deleted"` - `"retired"` - `tags?: Array | null` A flat array of tag names as strings to be applied to the resource. Tag names may be for either existing or new tags.

Requires `tag:create` scope. - `type?: "base" | "snapshot" | "backup" | 2 more` Describes the kind of image. It may be one of `base`, `snapshot`, `backup`, `custom`, or `admin`. Respectively, this specifies whether an image is a DigitalOcean base OS image, user-generated Droplet snapshot, automatically created Droplet backup, user-provided virtual machine image, or an image used for DigitalOcean managed resources (e.g. DOKS worker nodes). - `"base"` - `"snapshot"` - `"backup"` - `"custom"` - `"admin"` - `locked: boolean` A boolean value indicating whether the Droplet has been locked, preventing actions by users. - `memory: number` Memory of the Droplet in megabytes. - `name: string` The human-readable name set for the Droplet instance. - `networks: Networks` The details of the network that are configured for the Droplet instance. This is an object that contains keys for IPv4 and IPv6. The value of each of these is an array that contains objects describing an individual IP resource allocated to the Droplet. These will define attributes like the IP address, netmask, and gateway of the specific network depending on the type of network it is. - `v4?: Array` - `gateway?: string` The gateway of the specified IPv4 network interface. For private interfaces, a gateway is not provided. This is denoted by returning `nil` as its value. - `ip_address?: string` The IP address of the IPv4 network interface. - `netmask?: string` The netmask of the IPv4 network interface. - `type?: "public" | "private"` The type of the IPv4 network interface. - `"public"` - `"private"` - `v6?: Array` - `gateway?: string` The gateway of the specified IPv6 network interface. - `ip_address?: string` The IP address of the IPv6 network interface. - `netmask?: number` The netmask of the IPv6 network interface. - `type?: "public"` The type of the IPv6 network interface. **Note**: IPv6 private networking is not currently supported. - `"public"` - `next_backup_window: DropletNextBackupWindow | null` The details of the Droplet's backups feature, if backups are configured for the Droplet. This object contains keys for the start and end times of the window during which the backup will start. - `end?: string` A time value given in ISO8601 combined date and time format specifying the end of the Droplet's backup window. - `start?: string` A time value given in ISO8601 combined date and time format specifying the start of the Droplet's backup window. - `region: Region` - `available: boolean` This is a boolean value that represents whether new Droplets can be created in this region. - `features: Array` This attribute is set to an array which contains features available in this region - `name: string` The display name of the region. This will be a full name that is used in the control panel and other interfaces. - `sizes: Array` This attribute is set to an array which contains the identifying slugs for the sizes available in this region. sizes:read is required to view. - `slug: string` A human-readable string that is used as a unique identifier for each region. - `size: Size` - `available: boolean` This is a boolean value that represents whether new Droplets can be created with this size. - `description: string` A string describing the class of Droplets created from this size. For example: Basic, General Purpose, CPU-Optimized, Memory-Optimized, or Storage-Optimized. - `disk: number` The amount of disk space set aside for Droplets of this size. The value is represented in gigabytes. - `memory: number` The amount of RAM allocated to Droplets created of this size. The value is represented in megabytes. - `price_hourly: number` This describes the price of the Droplet size as measured hourly. The value is measured in US dollars. - `price_monthly: number` This attribute describes the monthly cost of this Droplet size if the Droplet is kept for an entire month. The value is measured in US dollars. - `regions: Array` An array containing the region slugs where this size is available for Droplet creates. - `slug: string` A human-readable string that is used to uniquely identify each size. - `transfer: number` The amount of transfer bandwidth that is available for Droplets created in this size. This only counts traffic on the public interface. The value is given in terabytes. - `vcpus: number` The number of CPUs allocated to Droplets of this size. - `disk_info?: Array` An array of objects containing information about the disks available to Droplets created with this size. - `size?: Size` - `amount?: number` The amount of space allocated to the disk. - `unit?: string` The unit of measure for the disk size. - `type?: "local" | "scratch"` The type of disk. All Droplets contain a `local` disk. Additionally, GPU Droplets can also have a `scratch` disk for non-persistent data. - `"local"` - `"scratch"` - `gpu_info?: GPUInfo` An object containing information about the GPU capabilities of Droplets created with this size. - `count?: number` The number of GPUs allocated to the Droplet. - `model?: string` The model of the GPU. - `vram?: Vram` - `amount?: number` The amount of VRAM allocated to the GPU. - `unit?: string` The unit of measure for the VRAM. - `size_slug: string` The unique slug identifier for the size of this Droplet. - `snapshot_ids: Array` An array of snapshot IDs of any snapshots created from the Droplet instance.
Requires `image:read` scope. - `status: "new" | "active" | "off" | "archive"` A status string indicating the state of the Droplet instance. This may be "new", "active", "off", or "archive". - `"new"` - `"active"` - `"off"` - `"archive"` - `tags: Array` An array of Tags the Droplet has been tagged with.
Requires `tag:read` scope. - `vcpus: number` The number of virtual CPUs. - `volume_ids: Array` A flat array including the unique identifier for each Block Storage volume attached to the Droplet.
Requires `block_storage:read` scope. - `disk_info?: Array` An array of objects containing information about the disks available to the Droplet. - `size?: Size` - `amount?: number` The amount of space allocated to the disk. - `unit?: string` The unit of measure for the disk size. - `type?: "local" | "scratch"` The type of disk. All Droplets contain a `local` disk. Additionally, GPU Droplets can also have a `scratch` disk for non-persistent data. - `"local"` - `"scratch"` - `gpu_info?: GPUInfo` An object containing information about the GPU capabilities of Droplets created with this size. - `count?: number` The number of GPUs allocated to the Droplet. - `model?: string` The model of the GPU. - `vram?: Vram` - `amount?: number` The amount of VRAM allocated to the GPU. - `unit?: string` The unit of measure for the VRAM. - `kernel?: Kernel | null` **Note**: All Droplets created after March 2017 use internal kernels by default. These Droplets will have this attribute set to `null`. The current [kernel](https://docs.digitalocean.com/products/droplets/how-to/kernel/) for Droplets with externally managed kernels. This will initially be set to the kernel of the base image when the Droplet is created. - `id?: number` A unique number used to identify and reference a specific kernel. - `name?: string` The display name of the kernel. This is shown in the web UI and is generally a descriptive title for the kernel in question. - `version?: string` A standard kernel version string representing the version, patch, and release information. - `vpc_uuid?: string` A string specifying the UUID of the VPC to which the Droplet is assigned.
Requires `vpc:read` scope. - `links: Links` - `actions?: Array` - `id?: number` A unique numeric ID that can be used to identify and reference an action. - `href?: string` A URL that can be used to access the action. - `rel?: string` A string specifying the type of the related action. ### Example ```typescript import Gradient from '@digitalocean/gradient'; const client = new Gradient(); const gpuDroplet = await client.gpuDroplets.create({ image: 'ubuntu-20-04-x64', name: 'example.com', size: 's-1vcpu-1gb', backups: true, ipv6: true, monitoring: true, region: 'nyc3', ssh_keys: [289794, '3b:16:e4:bf:8b:00:8b:b8:59:8c:a9:d3:f0:19:fa:45'], tags: ['env:prod', 'web'], user_data: '#cloud-config\nruncmd:\n - touch /test.txt\n', vpc_uuid: '760e09ef-dc84-11e8-981e-3cfdfeaae000', }); console.log(gpuDroplet); ```