Sign in
Remote Access

🛡️ Check whether a vanity hostname is available.

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>

get/api/v1/connect/vanity/availability

Query parameters

namestring required

The vanity label, without any domain suffix.

Response

namestring required

The normalized label the answer is about.

availableboolean required

Whether this server could claim the label right now.

reasonstring

Why not, when unavailable. Never says more than name_unavailable.

Changes

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