Check CAA (domain lock)

PUT
https://www.digicert.com/services/v2/domain/{{domain_id}}/caa

Use this endpoint to check a given domain's DNS CAA resource record for a domain lock account token.

If the correct token is found:

  • The API returns a status value of 1.
  • The domain's lock status (domain_locking_status) becomes enabled.

If the token is not found:

  • The API returns a status value of 0.
  • The domain's lock status (domain_locking_status) becomes pending.

To learn how to place your account token, see Domain locking – Locking your domain, step 6.

Example requests and responses

cURL
curl --request PUT 'https://www.digicert.com/services/v2/domain/{{domain_id}}/caa' \
--header 'X-DC-DEVKEY: {{api_key}}' \
--header 'Content-Type: application/json' \
--data-raw '{
  "account_token": {{account_token}}
}'
200 (token found)
{
  "status": "1"
}
200 (token not found)
{
  "status": "0"
}

Path parameters

Name Req/Opt Description
domain_id required Domain ID.

Request parameters

Name Req/Opt Type Description
account_token required string Domain lock account token. To get the account token, use the Domain info API.

Response parameters

Name Type Description
status string Number that represents domain lock status.
  • If 1, the account token is found, and domain locking is enabled.
  • If 0, the account token is not found, and domain locking is pending.