Skip to main content
POST
Create a server

Authorizations

Authorization
string
header
required

API token from your CloudBlast account settings. Pass as Authorization: Bearer <token>.

Body

application/json
plan_id
integer
required

Plan ID from GET /plans

Example:

1

location_id
integer
required

Location ID from GET /locations

Example:

1

template_slug
string
required

Template slug from GET /locations/{id}/templates

Example:

"ubuntu-24.04"

hostname
string | null

Server hostname. Defaults to the plan name if omitted.

Maximum string length: 191
Example:

"web-01.example.com"

ssh_key_ids
integer[]

IDs of saved SSH keys to install during provisioning. Obtain IDs from GET /ssh-keys. The generated root password remains available.

Required array length: 1 - 20 elements
Example:
reserved_ips
string[]

Your unused reserved IPs to give the server instead of new addresses, from GET /reserved-ips. The server is placed on the node that carries them; the lowest IPv4 becomes its main address, and without a reserved IPv4 or IPv6 it gets a new one of that type.

Required array length: 1 - 16 elements
Example:
main_ipv4
string

With reserved_ips: new gives the server a new main IPv4 and attaches all reserved IPv4 addresses as extras; an address from reserved_ips makes that one the main IPv4. Defaults to the lowest reserved IPv4.

Example:

"new"

main_ipv6
string

Same as main_ipv4, for IPv6.

Example:

"new"

Response

Server created

data
object