Skip to main content
GET
/
domains
/
{domainId}
JavaScript
import AIInbx from 'aiinbx';

const client = new AIInbx({
  apiKey: process.env['AI_INBX_API_KEY'], // This is the default and can be omitted
});

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

console.log(domain.id);
{
  "id": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "domain": "<string>",
  "verifiedAt": "<string>",
  "status": "VERIFIED",
  "isManagedDefault": true,
  "dnsRecords": [
    {
      "type": "TXT",
      "name": "<string>",
      "value": "<string>",
      "priority": 123,
      "isVerified": true,
      "verificationStatus": "verified",
      "lastCheckedAt": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication using Bearer token

Path Parameters

domainId
string
required

The unique identifier of the domain

Response

Successful response

id
string
required
createdAt
string
required
updatedAt
string
required
domain
string
required
verifiedAt
string | null
required
status
enum<string>
required
Available options:
VERIFIED,
PENDING_VERIFICATION,
NOT_REGISTERED
isManagedDefault
boolean
required
dnsRecords
object[] | null