Skip to main content
POST
Hold a domain name for the next server

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.

custom_domain
string | null

The value of custom_domain.

Maximum string length: 253

Response

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

The domain name held for the account's next order of an app that is reached by a name.

name
string
required

The name the server will answer on, such as vps-1a2b3c4d.my-advin.com.

Example:

"vps-ecc6f4f1.my-advin.com"

expires_at
string<date-time>
required

When the name is given up if no order is placed. Asking again starts the time over.

Examples:

"2026-09-03T04:21:17.000000Z"

"2026-09-14T16:42:09.000000Z"

custom_domain
string | null
required

The domain that was sent to be checked, now known to be a CNAME for name. Null when none was sent.

Example:

"panel.example.com"