Sign in
latestOpenAPI 3.1.02026-08-23100133183.1 KB

0d66c7340876

Instances

Deploy instance

Deploy a new instance.

Before deploying an instance, you need to add at least ssh key to be able to access your instance.

Instance types can be listed using the GET /instance-types endpoint.

Available images can be listed using the GET /images endpoint, using the image_type value from the result.

Existing detached OS volumes could be used as an image, put the volume ID as the image value.

It's also possible to define new volumes that will be created and attached to the new instance. New volumes location will be the same as the instance.

Existing detached volumes can be attached to the deployed instance by adding their IDs to the existing_volumes property.

post/v1/instances

Headers

user-agentstring required
cf-connecting-ipstring required

Request body

instance_typestring required
imagestring required

OS image specification for the created instance. There are two options:

  1. OS image type. For a list of supported images, check GET /images endpoint, "image_type" property. To set the name and size, use "os_volume" property.
  2. Previously customized OS volume ID. (To create an OS volume, first make an instance with existing "image" type. To customize the volume content, ssh into that instance. Finally, delete the instance but keep the volume.)
startup_script_idstring
hostnamestring required
descriptionstring required
location_codestring required

Location code for the instance and any newly created volumes

is_spotboolean

Create a spot instance. Spot instances may be evicted by Verda at any time without warning.

couponstring
existing_volumesstring[]

IDs of additional existing detached volumes to attach to this new instance when its created.

(To configure instance OS volume, use "image" and "os_volume" properties.)

contract'LONG_TERM' | 'PAY_AS_YOU_GO' | 'SPOT'
pricing'DYNAMIC_PRICE' | 'FIXED_PRICE'

This field is deprecated as DYNAMIC_PRICE is removed. Only FIXED_PRICE is supported now.

Example request

{
  "instance_type": "1H100.80S.30V",
  "image": "ubuntu-22.04-cuda-12.4-docker",
  "startup_script_id": "c6d04741-4646-4cfb-bb8e-a90da78ac6ef",
  "hostname": "my-instance-hostname",
  "tags": [
    {
      "key": "environment",
      "value": "production"
    },
    {
      "key": "benchmark"
    }
  ],
  "location_code": "FIN-01",
  "os_volume": {
    "name": "custom-os-volume-name",
    "tags": [
      {
        "key": "environment",
        "value": "production"
      }
    ]
  },
  "coupon": "COUPON-CODE-2026",
  "volumes": [
    {
      "name": "additional-volume-name",
      "size": 1000,
      "type": "NVMe"
    }
  ],
  "existing_volumes": [
    "902719b3-5a31-4eb1-bbf7-f2a12762c63b"
  ],
  "contract": "PAY_AS_YOU_GO",
  "pricing": "FIXED_PRICE"
}

Response

Instance ID