Skip to content
Norbelys
Esc
↑↓navigate↵open⌘Jpreview

Retrieve a sending domain.

GET/v1/sending_domains/{id}
Authorization
AuthorizationBearer token · headerrequired

An API key (nb_live_…, nb_test_…), a workspace token (nbs_…) or a CLI token (nbc_…).

Path parameters
idId_SendingDomainrequired

The sending domain id (dom_…).

matches ^dom_[0-9a-f]{32}$
Responses
200

The domain.

checked_atTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
created_atTimestamprequired
hostnamestringrequired

The hostname, lowercase.

idId_SendingDomainrequired
matches ^dom_[0-9a-f]{32}$
last_errorobject | null

What the last check found wrong: {code, detail, at}.

recordsDnsRecord[]required

The records to publish: the ownership TXT record, the tracking CNAME when the hostname serves tracking links, and the managed MTA's DKIM key once it signs for the domain.

max items 3
Show properties
Array of DnsRecord
namestringrequired

The record's name.

purposestringrequired

ownership, tracking or dkim (the managed MTA's key).

statusstringrequired

What the last check observed: verified, missing or unchecked.

typestringrequired

TXT or CNAME.

valuestringrequired

The record's value.

statusstringrequired

pending_verification, verifying, verified, pending_certificate, active, suspended or deleting; new values may be added.

tracking_enabledbooleanrequired

Whether the hostname serves tracking links.

updated_atTimestamprequired
verified_atTimestamp | null
Show properties
One of:
Timestamp
string<date-time>
null
null
versioninteger<int64>required

The domain's version, also the response's ETag: updated_at in microseconds since the Unix epoch. An update sent with it in If-Match applies only to this version. Each DNS check moves it too.

401

No valid credential.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

403

The credential lacks connections:read.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

404

No such sending domain in this workspace.

codestringrequired

The code from the closed registry; programs branch on it, never on the text. New codes may be added.

detailstringrequired

What went wrong, for a person; never an internal cause.

errorsFieldError[]

With validation_failed only: every invalid field.

Show properties
Array of FieldError
codestringrequired

What is wrong (required, range, length, format, invalid, …).

detailstringrequired

A safe, human-readable explanation.

pointerstringrequired

RFC 6901 pointer into the body, or ?name for a query parameter.

instancestringrequired

The request's path.

request_idstringrequired

The request's id, also in X-Request-Id: what support needs to find the request.

retry_afterinteger<int64> | null

With 429 and 503: the seconds to wait, as in Retry-After.

min 0
statusinteger<int32>required

The HTTP status.

min 0
titlestringrequired

Fixed per code.

typestringrequired

https://docs.norbelys.com/errors/<code>, a page that explains the code.

Try it
Server
Authorization
Parameters
Request
curl -X GET 'https://api.norbelys.com/v1/sending_domains/dom_0190f8a2b4c87a10b6d2e4f6a8c0e2f4' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "checked_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "hostname": "string",
  "id": "dom_0190f8a2b4c87a10b6d2e4f6a8c0e2f4",
  "last_error": {},
  "records": [
    {
      "name": "string",
      "purpose": "string",
      "status": "string",
      "type": "string",
      "value": "string"
    }
  ],
  "status": "string",
  "tracking_enabled": true,
  "updated_at": "2019-08-24T14:15:22Z",
  "verified_at": "2019-08-24T14:15:22Z",
  "version": 0
}