Skip to main content
GET
Get a server's live configuration

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

server
string
required

The server UUID

Example:

"ecc6f4f1"

Response

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

id
string
required

The short uuid, as everywhere else in the customer's payloads.

Example:

"ecc6f4f1"

uuid
string
required

The uuid UUID.

Example:

"ecc6f4f1-c89b-4dce-a20b-a330641c5b0b"

state
string
required

The billing state, province, or region, or null or an empty string to clear it.

Example:

"running"

locked
boolean
required

The value of locked.

Example:

false

config
ServerDetailConfigData · object
required

The value of config.

Example:
internal_id
integer
required

The primary key. See the note on id.

Example:

4821