Skip to main content
POST
Create basic VM

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
flavor_name
string
required

Flavor of the basic VM. To get the flavors, use List basic VM flavors.

Example:

"g2s-shared-1-2"

image_id
string<uuid4>
required

ID of the image that the basic VM boots from. The image must have a Linux operating system.

interfaces
BasicVmInterfaceInSerializer · object[]
required

Ports to attach, in the order of the network interfaces. Create the ports first with Create port.

Minimum array length: 1
region_id
integer
required

Region of the basic VM.

Example:

7

name
string

Basic VM name. 2-62 characters: letters, digits, spaces, dots, underscores, hyphens. If you omit it, the API makes a name.

Pattern: ^[a-zA-Z0-9][a-zA-Z 0-9._\-]{1,61}[a-zA-Z0-9._]$
password
string<password>
write-only

Password of the default user. No response returns it. For a Linux image, the password enables SSH login with a password. Send password or user_data, not both.

Minimum string length: 1
ssh_key_id
string<uuid4>

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

tags
CreateTagsSerializer · object

Key-value tags to associate with the resource. A tag is a key-value pair that can be associated with a resource, enabling efficient filtering and grouping for better organization and management. Both tag keys and values have a maximum length of 255 characters. Tag keys and values cannot contain characters from U+0080 to U+00FF. Some tags are read-only and cannot be modified by the user. Tags are also integrated with cost reports, allowing cost data to be filtered based on tag keys or values.

Example:
user_data
string

User data for cloud-init, as plain text or base64. The decoded data has a maximum of 65535 bytes.

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: