Retrieve Domain

TypeScript

import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

const domain = await client.domains.retrieve('dns_FdfQe2eZAzRrHCXKSr7VsxUz');

console.log(domain.id);

{
  "data": {
    "id": "<string>",
    "org_id": "<string>",
    "name": "<string>",
    "sending_records": [
      {
        "name": "<string>",
        "fullname": "<string>",
        "type": "TXT",
        "ttl": "<string>",
        "group": "DKIM",
        "value": "<string>",
        "region": "eu-west-1",
        "status": "bootstrapping",
        "kind": "record",
        "status_at": "<string>",
        "selector": "<string>",
        "priority": "<string>"
      }
    ],
    "status": "bootstrapping",
    "sending_status": "enabled",
    "status_at": "<string>",
    "open_tracking": true,
    "click_tracking": true,
    "created_at": "2023-11-07T05:31:56Z",
    "region": "eu-west-1",
    "kind": "domain",
    "modified_at": "2023-11-07T05:31:56Z"
  }
}

GET

domains

{id}

TypeScript

import Nuntly from '@nuntly/sdk';

const client = new Nuntly({
  apiKey: 'My API Key',
});

const domain = await client.domains.retrieve('dns_FdfQe2eZAzRrHCXKSr7VsxUz');

console.log(domain.id);

{
  "data": {
    "id": "<string>",
    "org_id": "<string>",
    "name": "<string>",
    "sending_records": [
      {
        "name": "<string>",
        "fullname": "<string>",
        "type": "TXT",
        "ttl": "<string>",
        "group": "DKIM",
        "value": "<string>",
        "region": "eu-west-1",
        "status": "bootstrapping",
        "kind": "record",
        "status_at": "<string>",
        "selector": "<string>",
        "priority": "<string>"
      }
    ],
    "status": "bootstrapping",
    "sending_status": "enabled",
    "status_at": "<string>",
    "open_tracking": true,
    "click_tracking": true,
    "created_at": "2023-11-07T05:31:56Z",
    "region": "eu-west-1",
    "kind": "domain",
    "modified_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization

string

header

required

Bearer HTTP authentication. Allowed headers Authorization: Bearer <API_KEY>

Path Parameters

string

required

The domain id previously created

Response

A successful response

data

object

Show child attributes

data.id

string

required

The id of the domain

data.org_id

string

required

The id of the organization

data.name

string

required

The name of the domain. For example: 'email.mycompany.com'

data.sending_records

object[]

required

The records for your domain

Show child attributes

data.sending_records.name

string

required

The name of the record.

data.sending_records.fullname

string

required

The FQDN of the domain record

data.sending_records.type

enum<string>

required

The type of the record: "TXT", "MX" or "CNAME"

Available options:

TXT,

MX,

CNAME

data.sending_records.ttl

string

required

TTL (Time To Live) for this DNS record specifies the duration (in seconds)

data.sending_records.group

enum<string>

required

The group of group: "DKIM", "SPF", "MX" or "DMARC". It is useful to group the records

Available options:

DKIM,

SPF,

MX,

DMARC

data.sending_records.value

string

required

The value of a DNS record is the data that the record points to

data.sending_records.region

enum<string>

required

The region of the related data

Available options:

eu-west-1

data.sending_records.status

enum<string>

required

The status of the record

Available options:

bootstrapping,

pending,

success,

failed,

temporary_failure

data.sending_records.kind

enum<string>

required

The kind of object returned

Available options:

record

data.sending_records.status_at

string

required

The date of the lastest verification of this record

data.sending_records.selector

string

A unique identifier in DKIM record to create CNAME records for verifying domain ownership and enabling email authentication

data.sending_records.priority

string

Priority in a DNS record, typically used in MX (Mail Exchange) records, specifies the order in which mail servers should be used, with lower values indicating higher priority for email delivery

data.status

enum<string>

required

The status for the domain

Available options:

bootstrapping,

pending,

success,

failed,

temporary_failure

data.sending_status

enum<string>

required

The sending status for the domain

Available options:

enabled,

disabled

data.status_at

string

required

The date of the lastest verification of the status

data.open_tracking

boolean

required

data.click_tracking

boolean

required

data.created_at

string<date-time>

required

Date at which the object was created (ISO 8601 format)

data.region

enum<string>

required

The region of the related data

Available options:

eu-west-1

data.kind

enum<string>

required

The kind of object returned

Available options:

domain

data.modified_at

string<date-time>

Date at which the object was modified (ISO 8601 format)

Create Domain List Domains

⌘I

Using the Nuntly API

Emails

API Keys

Domains

Webhooks

Webhooks Events

Account

Organizations

Memberships

Invitations

Retrieve Domain

Authorizations

Path Parameters

Response