Skip to main content

Check Domain Availability

GET 

/api/domains/:domain/available

Check if a domain is available across all tenants for both whitelabel and email usage.

This endpoint checks:

  1. Whether the exact domain is taken by any tenant for whitelabel hosting
  2. Whether the root domain is taken by any tenant for email

Args: domain: The domain to check (e.g., "app.example.com")

Returns: DomainAvailabilityResponse with detailed availability information

Example: GET /api/domains/app.example.com/available

Returns: { "whitelabel_domain_available": true, "email_domain_available": false, "domain": "app.example.com", "root_domain": "example.com", "message": "Root domain example.com is already taken for email" }

Request

Responses

Successful Response