TEteaflask
authed

Get Help Site Domain

get/api/v1/help-site/domain

Request

  • Base URL
    https://api.teaflask.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.teaflask.com/api/v1/help-site/domain
  • Auth
    none declared

Response

Successful Response

hostnamestring nullable required
status'pending_dns' | 'validating' | 'issuing' | 'active' | 'failed' required

A claimed docs hostname's walk to serving: the customer still owes the DNS records (pending_dns), ACM saw the validation record and is verifying (validating), the certificate issued and the CloudFront distribution is deploying (issuing), the edge answers (active), or provisioning gave up (failed). Terminal states are active and failed; everything else converges under the provisioning workflow.

validation_record_namestring nullable required
validation_record_valuestring nullable required
cname_targetstring nullable required
verified_atstring date-time nullable required
last_checked_atstring date-time nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.