Skip to main content
POST
Cancel a server order

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.

Path Parameters

serverOrder
string
required

The server order UUID

Example:

"0e6a7712-98ab-451b-8675-5c5ae96e4d3a"

Response

The request was accepted and is being carried out in the background.

A server order and its installation progress.

uuid
string
required

The uuid UUID.

Example:

"0e6a7712-98ab-451b-8675-5c5ae96e4d3a"

purchase_uuid
string | null
required

The checkout this machine was bought in, shared with every other machine ordered at the same time.

Example:

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

purchase_status
enum<string> | null
required

The purchase status, or null for an order without a purchase record.

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

"needs_funds"

status
enum<string>
required

The value of status.

Available options:
pending_payment,
provisioning,
configuring,
completed,
expired,
payment_review,
failed,
cancelled
Example:

"pending_payment"

status_label
string
required

The value of status_label.

Example:

"Needs funds"

is_placed
boolean
required

Whether the billing system has taken and been paid for this order, which is what separates "still placing" from "being built".

Example:

false

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."

plan_name
string
required

The value of plan_name.

Example:

"Standard 4 GB"

plan_key
string
required

The value of plan_key.

Example:

"032f97c3b0f718ae9a2edfba83d5adf321025b5d9af1e90d397e79b8667bb3a4"

vcpu_cores
integer
required

The value of vcpu_cores.

Example:

4

memory
integer
required

The value of memory.

Example:

4000

disk
integer
required

The value of disk.

Example:

80

bandwidth
integer
required

The value of bandwidth.

Example:

5000

hdd
boolean
required

The value of hdd.

Example:

false

location
string | null
required

The value of location.

Example:

"Kansas City, MO"

location_id
integer | null
required

The location id ID.

Example:

3

group_name
string | null
required

The value of group_name.

Example:

"Standard VPS"

hostname
string
required

The fully qualified hostname.

Example:

"hev-telemetry.blackmesa.example.com"

label
string | null
required

A short label shown to customers.

Example:

"hev-telemetry"

template_name
string | null
required

The value of template_name.

Example:

"Ubuntu 24.04"

template_icon_url
string | null
required

The value of template_icon_url.

Example:

"https://img.icons8.com/color/48/ubuntu.png"

billing
BillingData · object
required

The value of billing.

Example:
server_id
string | null
required

The installed server's short ID, or null until installation finishes.

Example:

null

can_cancel
boolean
required

Whether the customer can cancel.

Example:

true

created_at
string | null
required

The date and time for created at, in UTC.

Example:

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