Zum Inhalt springen

DNS Records

Zuletzt aktualisiert am

Lists all records of a specific DNS zone. Returns all records including their lock status.

URL: GET /api/v1/organizations/{orgId}/dns-zones/{dnsZoneId}/dns-resource-records

Example Response (200 OK):

[
{
"dnsResourceRecordId": "f7dfd377-cb4a-4417-8458-0a221ae3b835",
"name": "www",
"recordType": "A",
"recordData": "194.175.123.125",
"timeToLive": 3600,
"isLockedByUser": false,
"isLockedByProvider": false
}
]

Creates a new record in a primary zone.

URL: POST /api/v1/organizations/{orgId}/dns-zones/{dnsZoneId}/dns-resource-records

Request Body:

{
"name": "blog",
"recordClass": "IN",
"recordType": "A",
"recordData": "1.2.3.4",
"timeToLive": 3600
}

Specifically updates the values of an existing record (e.g., the IP address or the TTL) without having to delete and recreate it. Ideal for DynDNS scenarios or quick IP changes.

URL: PATCH /api/v1/organizations/{orgId}/dns-zones/{dnsZoneId}/dns-resource-records/{recordId}

Request Body:

{
"name": "www",
"recordClass": "IN",
"timeToLive": 3600,
"recordType": "AAAA",
"recordData": "2001:0db8:85a3:0000:0000:8a2e:0370:7334"
}

This function prevents critical records (e.g., your main web server) from being accidentally changed or deleted by scripts.

  • Lock URL: PATCH .../dns-resource-records/{recordId}/lock
  • Unlock URL: PATCH .../dns-resource-records/{recordId}/unlock

Request Body (Lock):

{
"reason": "Central Production-Server. Changes after Change-Request!"
}

Replaces the entire list of records in a zone. This is ideal for automated deployments (CI/CD) to establish a defined target state.

URL: PUT /api/v1/organizations/{orgId}/dns-zones/{dnsZoneId}/dns-resource-records

Request Body:

{
"dnsResourceRecords": [
{
"name": "@",
"recordType": "A",
"recordData": "1.1.1.1",
"timeToLive": 3600,
"recordClass": "IN"
},
{
"name": "mail",
"recordType": "MX",
"recordData": "10 mail.provider.de",
"timeToLive": 3600,
"recordClass": "IN"
}
]
}

Deletes a specific record using its ID.

URL: DELETE /api/v1/organizations/{orgId}/dns-zones/{dnsZoneId}/dns-resource-records/{recordId}

Response (Deleted successfully):

204 No Content

A “Full Cleanup” command. Deletes all resource records within a zone.

URL: DELETE /api/v1/organizations/{orgId}/dns-zones/{dnsZoneId}/dns-resource-records

Response (Deleted successfully):

204 No Content