Skip to main content
POST
Order servers

Authorizations

Authorization
string
header
required

Your API key, sent as a bearer token. Create one in the control panel under API Keys, give it only the permissions the integration needs, and copy it when it is created. It cannot be shown again. Each key is restricted to one owned team. The key determines the team for every request.

Body

application/json

Send a JSON object containing the fields below. Required fields are marked in the schema.

quote_token
string
required

The value of quote_token.

Maximum string length: 20000
quantity
integer
required

The value of quantity.

Required range: 1 <= x <= 10
hostnames
(string | null)[]
required

The value of hostnames.

Required array length: 1 element
Maximum string length: 191
template_uuid
string
required

The template uuid UUID.

account_password
string
required

The value of account_password.

Required string length: 5 - 191
hostname
string | null

The fully qualified hostname.

Maximum string length: 191
labels
(string | null)[]

The value of labels.

Required array length: 1 element
Maximum string length: 40
label
string | null

A short label shown to customers.

Maximum string length: 40
ssh_keys
string[]

The value of ssh_keys.

Maximum array length: 25
Required string length: 36
user_script
string | null

The value of user_script.

Required string length: 36

Response

The record, as a JSON object. There is no envelope.

A server purchase with its cost, payment status and orders.

uuid
string
required

The uuid UUID.

Example:

"a930b81e-663e-4e12-a437-001f207d5ac6"

status
enum<string>
required

The value of status.

Available options:
pending,
needs_funds,
paid,
refused,
expired,
cancelled
Example:

"needs_funds"

status_label
string
required

The value of status_label.

Example:

"Needs funds"

progress_message
string | null
required

The value of progress_message.

Example:

"Your balance is 2.00 USD short of the 12.00 USD this order costs. Add funds to continue."

amount
string
required

The whole purchase, as a decimal string in currency.

Example:

"12.00"

currency
string
required

The three-letter currency code used for monetary amounts.

Example:

"USD"

quantity
integer
required

The value of quantity.

Example:

1

orders
ServerOrderData · object[]
required

The value of orders.

Example:
created_at
string | null
required

The date and time for created at, in UTC.

Example:

"2026-09-14T16:31:47+00:00"