Sites

Check whether a subdomain is currently available

get/sites/availability

Request

  • Base URL: https://api.nippy.host
  • URL: https://api.nippy.host/sites/availability
  • Auth: none declared

Query parameters

subdomainstring required
Example:my-site

Candidate subdomain to check (lowercase, hyphens allowed, 3–63 chars)

Response

Availability check result

availableboolean required

True if the subdomain is free to claim

reason'invalid_format' | 'too_short' | 'too_long' | 'reserved' | 'taken'

Machine-readable reason when available is false

Changes

No recorded changes to this operation across all 1 revision of this API.