Skip to main content
POST
/
v1
/
auth
/
orgs
/
domains
/
challenges
/
dns
Start a DNS-based domain verification challenge.
curl --request POST \
  --url http://127.0.0.1:8787/v1/auth/orgs/domains/challenges/dns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "apex_domain": "<string>"
}
'
{
  "data": {
    "challenge_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_name": "<string>",
    "record_value": "<string>",
    "expires_at": "<string>",
    "conflict": {
      "organization_name": "<string>"
    }
  },
  "error": null
}

Authorizations

Authorization
string
header
required

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

Body

application/json
apex_domain
string
required
Required string length: 3 - 253

Response

DNS challenge issued.

data
object
required
error
null
required