Sign in
Remote Access

🛡️ Claim a vanity hostname for this server.

Answers from the Remote Access Server are passed through untouched, including its refusals: <code>422 invalid_name</code>, <code>409 name_unavailable</code> / <code>label_limit_reached</code>, <code>429 rename_cooldown</code>, <code>402 cert_unavailable</code> and <code>503 vanity_disabled</code>.<br /><hr /><h3>🛡️ Requires Capabilities: <code>ServerSettings.Update</code></h3>

put/api/v1/connect/vanity

Request body

namestring required

The vanity label to claim for this server, without any domain suffix.

Response

labelsstring[] required

Every vanity label this server currently holds.

primarystring nullable required

The label clients are pointed at, when one is set.

state'pending' | 'live' | 'failed' nullable required

Where the certificate covering the labels stands. pending means the name is claimed but not yet on a certificate.

Changes

Changed in 1 of the 176 revisions of this API.1