Keplars
Domains

Get domain status

GET
/api/v1/public/domains/domain-status/{domainID}

Returns the current verification state of a domain. Poll this after POST /api/v1/public/domains/add-domain until verification_status is verified. Requires domains:manage scope.

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication. Use a Regular API key for email sending, or an Admin API key for marketing and automation endpoints.

Get your API keys from Settings → API Keys (regular) or Settings → Admin API Keys (admin) in the dashboard.

In: header

Path Parameters

domainID*string

Domain ID returned by the add-domain endpoint.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://api.keplars.com/api/v1/public/domains/domain-status/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{
  "success": true,
  "message": "Success",
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "domain": "string",
    "verification_status": "pending",
    "mail_from_status": "string",
    "region": "us-east-1",
    "dns_records": [
      {
        "type": "TXT",
        "name": "keplars._domainkey.example.com",
        "value": "string",
        "priority": 0
      }
    ],
    "registrar": "string",
    "dns_provider": "string",
    "verified_at": "2019-08-24T14:15:22Z"
  }
}
{
  "success": false,
  "error": "VALIDATION_ERROR",
  "message": "Field 'to' is required"
}
{
  "success": false,
  "error": "VALIDATION_ERROR",
  "message": "Field 'to' is required"
}
{
  "success": false,
  "error": "VALIDATION_ERROR",
  "message": "Field 'to' is required"
}