API Reference · Status pages
Check subdomain availability
Query
statuspageSubdomainAvailabilityWhether a subdomain can be used. Pass statuspageId when editing a page: its own subdomain counts as available and its change cooldown applies.
statuspageSubdomainAvailability(
organizationUUID: ID!
subdomain: String!
statuspageId: Int
): StatuspageSubdomainAvailability!Arguments
Field
Type
Returns
StatuspageSubdomainAvailability!
Field
Type
Example
query StatuspageSubdomainAvailability($organizationUUID: ID!, $subdomain: String!, $statuspageId: Int) {
statuspageSubdomainAvailability(organizationUUID: $organizationUUID, subdomain: $subdomain, statuspageId: $statuspageId) {
available
subdomain
reason
message
changeAllowedAt
}
}Example response
{
"data": {
"statuspageSubdomainAvailability": {
"available": true,
"subdomain": "status.example.com",
"reason": "INVALID",
"message": "Example message",
"changeAllowedAt": "2026-01-01T12:00:00Z"
}
}
}