---
title: "🛡️ Check whether a vanity hostname is available."
method: GET
path: "/api/v1/connect/vanity/availability"
tags: ["Remote Access"]
---

# 🛡️ Check whether a vanity hostname is available.

`GET /api/v1/connect/vanity/availability`

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>

## Query parameters

- `name` string, required

## Response `200`

- VanityAvailabilityResponse
  - `name` string, required — The normalized label the answer is about.
  - `available` boolean, required — Whether this server could claim the label right now.
  - `reason` string — Why not, when unavailable. Never says more than `name_unavailable`.

## Other responses

- `400` — Possible reasons: Request validation failed, see response for details; Remote Access is not enabled on this server, or it holds no cloud credential.
- `401` — Possible reasons: The authorization token is invalid.
- `403` — Possible reasons: The user does not have sufficent capabilities.

## Changes

- **2026-08-22** `4d3a316ae17b` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api/changes/api/v1/connect/vanity/availability/get.md)

---

[API](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api.md) · [All operations](https://skmtc.dev/cardinalapps/apis/cardinal-media-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/cardinalapps/cardinal-media-server-api/revisions/7b5e4555e84f/schema)