Skip to main content
GET
Check domain availability
Check whether a host is available to connect inside Biqli. This is not a registrar lookup and does not tell you whether the domain can be purchased. Requires Custom domains: Write (custom_domains.create) and a plan that includes custom domains.

Responses

A host not claimed in Biqli:
A host already owned by the API-key user remains available for attachment to this workspace:
If the host is already attached to this workspace, reason is already_connected. This remains safe when another workspace member originally created the shared workspace domain. A claim owned by another Biqli account returns 200 OK with available: false, reason: domain_taken, and a null domain_id. It does not reveal who owns the domain. Invalid, unsafe, blacklisted, or application hosts return 422 validation_error. Because availability can change between checking and creating, always handle 409 domain_taken from Create a domain.

Shared API behavior

Authentication is workspace-scoped; see Authentication. Errors use the standard envelope and request IDs described in Errors, and requests are subject to Rate limits.

Authorizations

Authorization
string
header
required

A workspace API key beginning with biqli_.

Query Parameters

host
string
required
Maximum string length: 100

Response

Availability checked successfully.

host
string
required
available
boolean
required
reason
enum<string>
required
Available options:
available,
already_connected,
already_owned,
domain_taken
domain_id
string | null
required
Pattern: ^biq_dom_[0-9A-HJKMNP-TV-Z]{26}$
status
string
required
Allowed value: "success"