Skip to main content
GET
Get subdomain
Returns the full subdomain, including its DNS records and current status. Poll this endpoint to track a subdomain’s progress until its status is active, or configure a webhook_url when you register the subdomain to receive status changes without polling. See Subdomain statuses for what each status means. Note: Does not support Legacy subdomains. Migrate old certificates via the Dashboard to manage them via API.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Version
string
required

Management API version.

Path Parameters

id
string
required

Response

Subdomain object.

data
object
required