GET · Bearer

GET /api/v1/domains/:id

Summary

Status for one custom domain: pending or verified, mail, status_detail, warnings, and the required DNS records with per-record status, found, and hint. hint is null when that record is valid or no specific mistake was found. warnings is empty when none.

Request

This call has no JSON body.

Response

HTTP 200. Sample values illustrate the schema.

{
  "id": "inb_example",
  "domain": "string",
  "status": "pending",
  "status_detail": "string",
  "mail": {
    "receiving": true,
    "sending": true,
    "inboxes": true
  },
  "records": [
    {
      "role": "mx",
      "type": "MX",
      "host": "string",
      "value": "string",
      "status": "valid",
      "found": [
        "string"
      ],
      "hint": {
        "code": "duplicated_suffix",
        "message": "string"
      }
    }
  ],
  "warnings": [
    {
      "code": "existing_mail_provider",
      "message": "string"
    }
  ]
}

Errors

  • HTTP 404 domain_not_found

Idempotency

This route does not document Idempotency-Key or client_id.