Skip to content

Get a single domain

GET
/api/organizations/{organizationId}/domains/{id}

Returns the full detail representation of one domain, including its live DNS records fetched from the managed DNS zone.

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext).

Type
API Key (header: X-API-TOKEN)
or
JWT

JWT access token obtained via POST /api/auth/login. Send as: Authorization: Bearer .

Type
HTTP (bearer)

Parameters

Path Parameters

organizationId*

Organization identifier

Type
string
Required
id*

domain identifier

Type
string
Required

Responses

domain resource

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "0193b6c2-8f1a-7c3d-9e2b-1a2b3c4d5e6f",
  
"name": "example.com",
  
"shared": false,
  
"dnsEnabled": true,
  
"dnsStatus": "active",
  
"dnsRecordCount": 12,
  
"dnsRecords": [
  
  
{
  
  
  
"@context": "string",
  
  
  
"@id": "string",
  
  
  
"@type": "string",
  
  
  
"recordId": 123456,
  
  
  
"domainId": "0f8fad5b-d9cb-469f-a165-70867728950e",
  
  
  
"type": 0,
  
  
  
"ttl": 3600,
  
  
  
"value": "192.0.2.1",
  
  
  
"name": "www",
  
  
  
"weight": 0,
  
  
  
"priority": 10,
  
  
  
"port": 0,
  
  
  
"flags": 0,
  
  
  
"tag": "issue",
  
  
  
"monitorStatus": 0,
  
  
  
"monitorType": 0,
  
  
  
"comment": "Primary web server",
  
  
  
"id": "0f8fad5b-d9cb-469f-a165-70867728950e:123456",
  
  
  
"typeString": "A"
  
  
}
  
],
  
"createdAt": "2026-01-15T09:30:00+00:00",
  
"updatedAt": "2026-01-16T12:00:00+00:00"
}

Playground

Authorization
Variables
Key
Value

Samples

Powered by VitePress OpenAPI