Documentation/Retrieve a domain

Retrieve a domain

Retrieve a domain, its capabilities, and its DNS records.

GET/domains/{domain_id}

Path parameters

NameTypeDescription

domain_idrequiredstring

`200` response

Domain

FieldTypeDescription

idrequiredstring

namerequiredstring

statusrequiredstring

regionrequiredstring

recordsrequiredarray

tlsstring

managed_unsubscribe_defaultboolean

Whether omitted or null email unsubscribe values enable Boundry-managed RFC 8058 headers.

capabilitiesobject

request.ts

typescript

import { Boundry } from "boundry-sdk";

const boundry = new Boundry({
  apiKey: process.env.BOUNDRY_API_KEY!,
});

const response = await boundry.api.getDomain({
  domain_id: "string"
});

response.json200 response

application/json

{
  "id": "string",
  "name": "string",
  "status": "string",
  "region": "string",
  "tls": "string",
  "managed_unsubscribe_default": true
}