NYnylas
Manage Domains

Get domain info

Changed on
<div id="admonition-warning">⚠️ <b>Before you can use the Manage Domains endpoints, you need a <a href="/docs/v3/auth/nylas-service-account/">Nylas Service Account</a></b>.</div>

Returns the DNS record information and verification status for the specified verification type. Use this endpoint to retrieve the DNS records you need to add at your DNS provider before calling the Verify domain endpoint.

post/v3/admin/domains/{domain_id}/info

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

type'ownership' | 'mx' | 'spf' | 'dkim' | 'feedback' required

The type of DNS verification to get info for.

Example request

{
  "type": "ownership"
}

Response

OK

request_idstring

ID of the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": {
    "domain_id": "abc-123-domain-id",
    "attempt": {
      "type": "ownership",
      "options": {
        "host": "@",
        "type": "TXT",
        "value": "nylas-ownership-verify=gNIeZAtY1lPUEpWOhA2XBB..."
      }
    },
    "status": "pending",
    "created_at": 1770242496,
    "expires_at": 1770415296,
    "message": "Please configure the TXT record for the domain to the returned options. Once done, you can retry the verification."
  }
}

Changes