Skip to main content
PATCH
Update domain

Authorizations

api_access_token
string
header
required

Path Parameters

id
integer
required

ID of the domain

account_id
integer
required

The numeric ID of the account

Body

application/json
domain
object

Response

Success

id
integer
custom_domain
string
certificate_status
string | null

Certificate status reported by Cloudflare (e.g. pending_validation, active).

live
boolean

Whether the certificate has settled and the domain serves the portal.

verification_errors
string | null
dns_record
object

The record the domain owner creates at their DNS provider. A zone apex gets an ALIAS (CNAME flattening) on @, since it cannot hold a CNAME next to its MX records.

created_at
integer