Skip to content

Update a domain

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

Partially updates a domain. Only dnsEnabled is writable through this operation: toggling it on provisions a managed DNS zone for the domain, which is required before DNS records can be imported, exported, or edited.

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

Request Body

application/merge-patch+json
JSON
{
  
"dnsEnabled": true
}

Responses

domain resource updated

JSON
{
  
"@context": "string",
  
"@id": "string",
  
"@type": "string",
  
"id": "0193b6c2-8f1a-7c3d-9e2b-1a2b3c4d5e6f",
  
"name": "example.com",
  
"shared": false,
  
"dnsEnabled": true,
  
"dnsStatus": "active",
  
"dnsRecordCount": 12,
  
"createdAt": "2026-01-15T09:30:00+00:00",
  
"updatedAt": "2026-01-16T12:00:00+00:00"
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI