Skip to main content
POST
Rename a 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.

Path Parameters

server
string
required

The server UUID

Example:

"ecc6f4f1"

Body

application/json

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

name
string
required

The name shown to customers.

Required string length: 1 - 40
Pattern: ^[^\p{C}<>]+$
hostname
string
required

The fully qualified hostname.

Required string length: 1 - 191

Response

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

What a server is called, answered after a rename.

name
string
required

The server's display name.

Example:

"lambda-core"

hostname
string
required

The fully qualified hostname.

Example:

"lambda-core.blackmesa.example.com"