Claim a domain; verify it next.

POST

/api/v1/domains

curl --request POST \
  --url https://example.com/api/v1/domains \
  --header 'Content-Type: application/json' \
  --data '{ "domain": "example.com" }'

Request Body^required

Media typeapplication/json

object

domain

required

string

Example

example.com

Responses

201

Media typeapplication/json

object

id

required

string format: uuid

domain

required

string

status

required

pending, verified or revoked.

string

challengeName

required

The TXT record that proves the claim, and its value.

string

challengeValue

required

string

method

txt or the provider kind that proved it.

string | null

createdBy

required

string

createdAt

required

string

verifiedAt

string | null

lastCheckedAt

string | null

lastError

string | null

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "domain": "example",
  "status": "example",
  "challengeName": "example",
  "challengeValue": "example",
  "method": "example",
  "createdBy": "example",
  "createdAt": "example",
  "verifiedAt": "example",
  "lastCheckedAt": "example",
  "lastError": "example"
}

409

Claimed already, here or elsewhere

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}

422

Media typeapplication/json

Problem Details body.

object

code

required

Stable machine-readable code, e.g. forbidden.

string

title

required

Short human readable title.

string

status

required

HTTP status.

integer format: int32

detail

Details, if safe to expose.

string | null

Example

{
  "code": "forbidden"
}