Orders

Order a server

Orders a server, paid from the balance. It comes back right away with status provisioning; Linux is ready in a few minutes, Windows in about 10 to 20. Poll Get a server until setup.stage is ready.

POST/orders

Authorization

Authorizationheaderrequired

Bearer rv_…, a key with the order scope. About keys

Body

application/json

plan_idintegerrequired

From List plans.

region_idintegerrequired

From List locations; must be in the plan’s available_region_ids.

distro_idintegerrequired

From List operating systems.

durationintegeroptional, default 1

Months, 1 to 12.

ssh_keystringoptional

A public SSH key for Linux servers.

Response

idstring (uuid)

The server id.

hostnamestring | null

The name you gave it.

ip_addressstring | null

Public IPv4 address, null while it’s being created.

statusstring

provisioning, reinstalling, moving, running, stopped, suspended, expired or deleted.

distro_namestring | null

Operating system, e.g. Windows Server 2022.

plan_idinteger

The plan, see List plans.

region_idinteger

The location, see List locations.

distro_idinteger

The operating system, see List operating systems.

sell_pricestring (decimal)

Monthly price in USD.

duration_monthsinteger

The term it was ordered for.

expiry_datestring (datetime) | null

Paid until.

auto_renewboolean

Renews from the balance before it expires.

created_atstring (datetime)

When it was ordered.

suspended_atstring (datetime) | null

Set while the server is suspended.

suspend_reasonstring | null

Why, when it is.

Status codes

200Success.

401No key, a wrong key, or a revoked or expired one.

402The balance doesn’t cover it. detail has message, required and balance.

400Something in the request is wrong, for example an unknown plan or a duration over 12.

429More than 120 requests a minute with one key, or too many wrong keys from one address.