Create a new instance

POST

This endpoint is used to create a new instance. You must provide a custom name for the instance, its gpu_type, and the name of its ssh_key.

If no values are provided for the gpu_count and operating_system_label, the default values of 1 and ubuntu_20_04_lts_nvidia are used respectively.

Headers

api-keystringOptional

Request

This endpoint expects an object.
gpu_typeenumRequired

The GPU type of the instance.

ssh_keystringRequired

The SSH key name to add to the instance. This SSH key is used to connect to the instance.

namestringOptional

The custom name of the instance.

gpu_countintegerOptionalDefaults to 1

The number of GPUs to attach to the instance.

operating_system_label"ubuntu_20_04_lts_nvidia" or "ubuntu_22_04_lts_nvidia"Optional
Allowed values: ubuntu_20_04_lts_nvidiaubuntu_22_04_lts_nvidia

The operating system label used to create the instance.

regionenumOptional

The region in which to create the instance.

volumeslist of objectsOptional

The volumes attached to the instance.

Built with