Sign in

v1

latestOpenAPI 3.0.02026-07-1771620.9 KB

Launch instances

Launches one or more instances of a given instance type.

post/instance-operations/launch

Request body

region_namestring required

Short name of a region

instance_type_namestring required

Name of an instance type

ssh_key_namesSshKeyName[] required

Names of the SSH keys to allow access to the instances. Currently, exactly one SSH key must be specified.

file_system_namesFileSystemName[]

Names of the file systems to attach to the instances. Currently, only one (if any) file system may be specified.

quantityinteger

Number of instances to launch

namestring nullable

User-provided name for the instance

Example request

{
  "region_name": "us-tx-1",
  "instance_type_name": "gpu_1x_a100",
  "ssh_key_names": [
    "macbook-pro"
  ],
  "file_system_names": [
    "shared-fs"
  ],
  "name": "training-node-1"
}

Response

OK

Example response

{
  "data": {
    "instance_ids": [
      "0920582c7ff041399e34823a0be62549"
    ]
  }
}