Skip to main content
POST
Create instance

Authorizations

Authorization
string
header
required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234_abcdef

Path Parameters

project_id
integer
required

Project ID.

Example:

1

Query Parameters

dry_run
boolean
default:false

Run every check of the real request and change nothing. The response has the status code and the schema of the real call, and an empty list of tasks. With false, the default, the request does the operation.

Body

application/json
boot_volume_id
string<uuid4>
required

Pre-created boot volume UUID.

flavor_name
string
required

Name of an instance flavor with no GPU. Use GET /v1/projects/{project_id}/instances/flavors to list them.

Example:

"g2-standard-32-64"

interfaces
VirtualInstanceInterfaceCreateSerializer · object[]
required

Pre-created ports to attach, in NIC/boot order.

Minimum array length: 1
region_id
integer
required

Region to provision the instance in.

Example:

7

data_volume_ids
string<uuid4>[]

Pre-created data volume UUIDs to attach.

name
string

Instance name. If you omit it, the name template of the account gives the name. Without a template, the name is generated. The account can forbid custom names. Then the name must be equal to the name that the template gives.

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
Example:

"web-1"

password
string<password>
write-only

Password of the default user. No response returns it. A Windows image needs a password. For a Windows image, the create checks these rules: the password has a minimum of 6 characters, it contains no word 'admin', and it contains 3 of these character types: digits, lowercase letters, uppercase letters, other characters. For a Linux image, the password enables SSH login with a password. Send password or user_data, not both.

Minimum string length: 1
placement_group_id
string<uuid4>

Pre-created placement group UUID for affinity/anti-affinity.

ssh_key_id
string<uuid4>

ID of the SSH key to add to the default user.

tags
CreateTagsSerializer · object

Customer-owned key-value tags.

user_data
string

cloud-init user data, raw or base64. Up to 65535 bytes once decoded.

Minimum string length: 1

Response

Task IDs

tasks
string[]
required

List of task IDs representing asynchronous operations. Use these IDs to monitor operation progress:

  • GET /v1/tasks/{task_id} - Check individual task status and details Poll task status until completion (FINISHED/ERROR) before proceeding with dependent operations.
Example: