Skip to main content
GET
Check Name Availability

Authorizations

X-API-Key
string
header
required

Your Cycls API key, from https://cloud.cycls.com. Sent as the X-API-Key header. This is the CYCLS_API_KEY the CLI uses.

Query Parameters

name
string
required

Response

Successful Response

available
boolean
required

Whether the name can be used by the caller

reason
string | null

Reason if unavailable