Update a DNS record

PATCH

/api/organizations/{organizationId}/domains/{domainId}/dns-records/{id}

Update an existing DNS record. Only the fields present in the request body are changed; omitted fields keep their current values. To clear the optional priority, send it explicitly as null.

Unlike create, name and value are not required. The type-based field-allow rules still apply (monitorType/weight only for A, AAAA, CNAME; flags/tag only for CAA; priority/weight/port only for SRV), and the same range checks are enforced (ttl 15-86400; priority/weight/port 0-65535; flags 0-255).

Authorizations

ApiToken

Long-lived API token created via POST /api/api-tokens (returned once in plaintext). A token created with readOnly may only perform safe requests (GET, HEAD, OPTIONS); write requests are rejected on every endpoint.

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

domainId*

dns-record identifier

Type

string

Required

id*

dns-record identifier

Type

string

Required

Request Body

application/merge-patch+json

{

  

"type": 0,

  

"ttl": 3600,

  

"value": "192.0.2.1",

  

"name": "www",

  

"weight": 0,

  

"priority": 10,

  

"port": 0,

  

"flags": 0,

  

"tag": "issue",

  

"monitorType": 0,

  

"comment": "Primary web server"

}

Responses

dns-record resource updated

Content-Type

{

  

"@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"

}

PATCH

/api/organizations/{organizationId}/domains/{domainId}/dns-records/{id}

Playground

Authorization

ApiToken

Variables

Key

Value

organizationId*

domainId*

id*

Body

Samples

Powered by VitePress OpenAPI