Sign in
zones

Batch create, update, and/or delete records in a zone

Performs multiple record operations (create, update and/or delete) for a zone in a single request for atomicity and efficiency.

post/{account}/zones/{zone}/batch

Path parameters

accountinteger required

The account id

zonestring required

The zone name

Request body

Example request

{
  "creates": [
    {
      "name": "ab",
      "type": "A",
      "content": "3.2.3.4",
      "ttl": 3600
    }
  ],
  "updates": [
    {
      "id": 67622534,
      "content": "3.2.3.40"
    }
  ],
  "deletes": [
    {
      "id": 67622509
    }
  ]
}

Response

Successfully processed batched zone record changes.

Example response

{
  "data": {
    "creates": [
      {
        "id": 67623409,
        "zone_id": "example.com",
        "parent_id": null,
        "name": "ab",
        "content": "3.2.3.4",
        "ttl": 3600,
        "priority": null,
        "type": "A",
        "regions": [
          "global"
        ],
        "system_record": false,
        "created_at": "2025-09-05T05:25:00Z",
        "updated_at": "2025-09-05T05:25:00Z"
      }
    ],
    "updates": [
      {
        "id": 67622534,
        "zone_id": "example.com",
        "parent_id": null,
        "name": "update1-1757049890",
        "content": "3.2.3.40",
        "ttl": 3600,
        "priority": null,
        "type": "A",
        "regions": [
          "global"
        ],
        "system_record": false,
        "created_at": "2025-09-05T04:40:15Z",
        "updated_at": "2025-09-05T05:25:00Z"
      }
    ],
    "deletes": [
      {
        "id": 67622509
      }
    ]
  }
}

Changes

Changed in 2 of the 53 revisions of this API.11