Get domain detail + required DNS records

GET https://emails.routeon.io/api/v1/domains/{id}

Parameters

id string<uuid> required path

Responses

200 OK
404 Resource not found within tenant scope
503 The mail provider is not configured in this environment. meta.reason=INTERNAL_ERROR, meta.details.code=kumo_provider_misconfigured — returned by POST /domains, GET /domains/{id}, POST /domains/{id}/verify and POST /domains/{id}/provider for a domain on `kumomta` when the platform's bounce-host address has no value. An operational misconfiguration, not a client mistake; retrying the same request will not help until it is fixed.

Example response · 200

{
    "status": "success",
    "http_code": 0,
    "payload": {
        "id": "00000000-0000-0000-0000-000000000000",
        "domain": "string",
        "status": "pending_dns",
        "provider": [],
        "dkim_selector": "string",
        "warmup_enabled": true,
        "dns_records": [
            {
                "record": "SPF",
                "type": "TXT",
                "host": "string",
                "value": "string",
                "priority": 0,
                "mandatory": true
            }
        ],
        "verified_at": "2024-01-01T00:00:00Z",
        "reputation_verdict": "pass",
        "reputation_reasons": [
            {
                "check": "string",
                "code": "string",
                "detail": "string"
            }
        ],
        "reputation_checked_at": "2024-01-01T00:00:00Z",
        "created_at": "2024-01-01T00:00:00Z"
    },
    "meta": []
}

Example response · 404

{
    "status": "error",
    "http_code": 0,
    "payload": [],
    "meta": {
        "reason": "VALIDATION_ERROR",
        "validation_error": [
            {
                "field": "string",
                "message": "string"
            }
        ],
        "details": []
    }
}

Example response · 503

{
    "status": "error",
    "http_code": 0,
    "payload": [],
    "meta": {
        "reason": "VALIDATION_ERROR",
        "validation_error": [
            {
                "field": "string",
                "message": "string"
            }
        ],
        "details": []
    }
}