Get batch status

GET

/domains/batch/{batchId}

Get the provisioning status of a domain batch, including per-domain NS records grouped by nameserver pair. Poll this endpoint to track when domains move from QUEUED → PENDING_NS → ACTIVE.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200

application/json

Batch status

Body

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/domains/batch/' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "success": true,
    "data": {
        "batchId": "batch_abc123",
        "status": "PARTIAL",
        "total": 10,
        "queued": 0,
        "pending_ns": 7,
        "active": 3,
        "failed": 0,
        "groups": [
            {
                "ns1": "ajay.ns.cloudflare.com",
                "ns2": "braelyn.ns.cloudflare.com",
                "domains": [
                    {
                        "id": "dom_abc123",
                        "domain": "yourdomain.com",
                        "status": "PENDING_NS",
                        "createdAt": "2026-03-12T00:00:00.000Z"
                    },
                    {
                        "id": "dom_abc124",
                        "domain": "anotherdomain.com",
                        "status": "ACTIVE",
                        "createdAt": "2026-03-12T00:00:00.000Z"
                    }
                ]
            }
        ]
    }
}

Modified at 2026-03-12 08:23:30

Verify domain NS propagation

Request mailboxes