Skip to main content
POST
Start 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

region_id
integer
required

Region ID

instance_id
string<uuid4>
required

Instance ID

Body

application/json
activate_profile
boolean
default:true

Automatically activates the DDoS protection profile when the associated instance is started

Example:

true

Response

200 - application/json

OK

addresses
Addresses · object
required

Map of network_name to list of addresses in that network

blackhole_ports
BlackholePortSerializer · object[]
required

IP addresses of the instances that are blackholed by DDoS mitigation system

created_at
string<date-time>
required

Datetime when instance was created

Example:

"2023-11-29T10:56:49Z"

creator_task_id
string | null
required

Task that created this entity

ddos_profile
GetClientProfileSerializer · object | null
required

Advanced DDoS protection profile. It is always null if query parameter with_ddos=true is not set.

fixed_ip_assignments
IpAssignmentsSerializer · object[] | null
required

Fixed IP assigned to instance

flavor
Instance flavor · object
required

Instances flavor schema embedded into instance schema

id
string<uuid4>
required

Instance ID

Example:

"6c6aa80f-7836-4dc2-a2ae-125e248be476"

instance_description
string | null
required

Instance description

Example:

"Instance description"

instance_isolation
IsolationSerializer · object | null
required

Instance isolation information

name
string
required

Instance name

Example:

"my-instance-1"

project_id
integer
required

Project ID

Example:

111

region
string
required

Region name

Example:

"Luxembourg"

region_id
integer
required

Region ID

Example:

4

security_groups
NameSerializerPydantic · object[]
required

Security groups

ssh_key_name
string | null
required

SSH key assigned to instance

status
enum<string>
required

Instance status

Available options:
ACTIVE,
BUILD,
DELETED,
ERROR,
HARD_REBOOT,
MIGRATING,
PASSWORD,
PAUSED,
REBOOT,
REBUILD,
RESCUE,
RESIZE,
REVERT_RESIZE,
SHELVED,
SHELVED_OFFLOADED,
SHUTOFF,
SOFT_DELETED,
SUSPENDED,
UNKNOWN,
VERIFY_RESIZE
Example:

"ACTIVE"

tags
TagSerializer · object[]
required

List of key-value tags associated 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. 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:
task_id
string | null
required

The UUID of the active task that currently holds a lock on the resource. This lock prevents concurrent modifications to ensure consistency. If null, the resource is not locked.

Example:

null

task_state
string | null
required

Task state

vm_state
enum<string>
required

Virtual machine state (active)

Available options:
active,
building,
deleted,
error,
paused,
rescued,
resized,
shelved,
shelved_offloaded,
soft-deleted,
stopped,
suspended
Example:

"active"

volumes
InstanceVolumeSerializer · object[]
required

List of volumes