Let your customers use their own hostnames. You create a claim for a hostname with the DNS records your product needs; we check public DNS and tell you when your customer has set them up.
Sign in and enable this API to get an API key and start calling it.
Endpoints · 5 of 5
curl -X GET https://eu-north-1.apimercado.com/v1/@capitalenesti/domains-api/v1/domains?externalId=string&status=pending&changedSince=0&limit=100 \ -H "X-API-Key: $API_KEY"
Request
{
"externalId": "string",
"status": "pending",
"changedSince": "0",
"limit": 100
}Response
{
"data": [
{
"id": "clm_5b0e7c55-3f5e-4d0a-9a43-2f1c1f6f2a10",
"status": "pending",
"records": [
{
"name": "string",
"type": "A",
"value": "string",
"outcome": "pass",
"observed": [
"string"
],
"priority": 0,
"required": true,
"checkedAt": "string",
"ownership": true
}
],
"ttlDays": 0,
"failedAt": "string",
"hostname": "shop.example.com",
"metadata": {
"<key>": null
},
"changeSeq": "string",
"createdAt": "string",
"deletedAt": "string",
"expiresAt": "string",
"ownership": {
"name": "string",
"value": "string"
},
"externalId": "string",
"verifiedAt": "string",
"lastCheckAt": "string",
"lastCheckError": "string",
"consecutiveFailures": 0
}
],
"meta": {
"requestId": "string",
"apiVersion": "string",
"nextCursor": "string"
}
}Let your customers use their own hostnames. You create a claim for a hostname with the DNS records your product needs; we check public DNS and tell you when your customer has set them up.
_domain-verify.<hostname> (prefix and
value configurable). Your customer adds it next to your records to prove they control the zone.pending until its ownership record and every required record pass one
check; then it is verified. A verified claim that fails 3 checks in a row, a minute apart, becomes
failed, and turns verified again when its records come back. A pending or failed claim that stays
not verified for ttlDays reads as expired. A DNS error (timeout, SERVFAIL) never fails a claim.GET /v1/domains/{id} or pressing "check now"
(POST /v1/domains/{id}/verify) keeps it in the window for 2 more hours. Outside the window, a
claim is checked when you read it or ask for a check. A verified claim with a record that does not
pass yet (an optional record your customer adds later) is rechecked every 10 minutes until it does.GET /v1/domains?changedSince=<cursor> every minute or so and keep the
statuses locally, so your hot paths never wait on this API. Start with changedSince=0 and pass
meta.nextCursor on the next call. The poll returns deleted claims too.Only creating a claim is charged. Every check that claim ever gets, including "check now", is included. A rejected create (400, 409) is not charged.
Every success is { data, meta }; every error is { error: { code, message, status, requestId } }
with a stable, lowercase code.
Domains API (id e72bpbz582mh/domains-api) · Provider documents: Terms · Privacy · Setup guide for agents