Retrieve a domain by name

Returns the domain configuration and the DNS records that must be in place. This is a pure read; call domains.verify to refresh verification status from DNS.

Authorization

Authorization<token>

API key authentication. Allowed headers-- "Authorization: ApiKey <novu_secret_key>".

In: header

Path Parameters

domainRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

_idRequiredstring

nameRequiredstring

statusRequiredstring

Value in: "pending" | "verified"

mxRecordConfiguredRequiredboolean

dnsProviderstring

_environmentIdRequiredstring

_organizationIdRequiredstring

createdAtRequiredstring

updatedAtRequiredstring

expectedDnsRecordsarray<object>

@minItems 0

dataobject

String key-value metadata (max 10 keys, 500 characters total when set via API).

export interface Response {
  _id: string;
  name: string;
  status: "pending" | "verified";
  mxRecordConfigured: boolean;
  dnsProvider?: string;
  _environmentId: string;
  _organizationId: string;
  createdAt: string;
  updatedAt: string;
  /**
   * @minItems 0
   */
  expectedDnsRecords?: ExpectedDnsRecordDto[];
  /**
   * String key-value metadata (max 10 keys, 500 characters total when set via API).
   */
  data?: {
    [k: string]: string;
  };
}
export interface ExpectedDnsRecordDto {
  type: string;
  name: string;
  content: string;
  ttl: string;
  priority?: number;
}

curl -X GET "https://api.novu.co/v1/domains/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

{
  "_id": "string",
  "name": "string",
  "status": "pending",
  "mxRecordConfigured": true,
  "dnsProvider": "string",
  "_environmentId": "string",
  "_organizationId": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "expectedDnsRecords": [
    {
      "type": "MX",
      "name": "inbound",
      "content": "inbound-smtp.us-east-1.amazonaws.com",
      "ttl": "Auto",
      "priority": 10
    }
  ],
  "data": {
    "property1": "string",
    "property2": "string"
  }
}

Authorization

Path Parameters

Header Parameters

Response Body

On this page