Instances

Deploy instance

Changed on

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

Request

  • Base URL: https://api.verda.com
  • URL: https://api.verda.com/v1/instances
  • Auth: HTTP bearer

Request body

instance_group_idstring

Create this instance in the given instance group.

instance_typestring

Required unless instance_group_id is set, in which case the group supplies it.

imagestring

Required unless instance_group_id is set, in which case the group's template supplies the default (a group instance may override it).

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

  1. OS image type or UUID. For a list of advertised images, check GET /images. Hidden images can also be deployed directly. The image must be enabled or explicitly enabled for the project owner. 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

Optional instance description.

location_codestring

Location code for the instance and any newly created volumes. Required unless instance_group_id is set, in which case the group supplies it.

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_group_id": "17288384-be2e-4162-8c3d-45b4aed43a65",
  "instance_type": "1H100.80S.30V",
  "image": "ubuntu-22.04-cuda-12.4-docker",
  "startup_script_id": "285a0f18-d12a-4d4a-81b4-951a186ecc83",
  "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": [
    "ea74891e-8493-4fcb-a8fe-f2c0a6974338"
  ],
  "contract": "PAY_AS_YOU_GO",
  "pricing": "FIXED_PRICE"
}

Response

Instance ID

Changes

  • 31918503bdd7Revision changes
    • warning

      deleted the header request parameter cf-connecting-ip

    • warning

      deleted the header request parameter user-agent

  • feda601a5b19Revision changes
    • info

      added the new optional request property

    • info

      the request property became optional

    • info

      the request property became optional

    • info

      the request property became optional