Submitting an async Cloudflare import job

Queue an async import job for domains your customer already owns. This endpoint is capped at 500 domains per request and returns immediately with an in_progress import job. Poll GET /domains/import/jobs/{id} or listen for domain_import.* webhooks for the terminal result.

Live async job creation uses the normal Partner API rate limit and does not reject just because Cloudflare accounts are currently busy. The backend keeps the import on one selected Cloudflare account.

Retrying the same normalized domain set is safe: Peeker hashes the sorted unique domains server-side and returns the existing import job. No idempotency header is required.

POST

domains

import

jobs

Submitting an async Cloudflare import job

curl --request POST \
  --url https://api.peeker.ai/partner/v1/domains/import/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "acme-mail.com",
    "team-acme.com"
  ]
}
'

{
  "data": {
    "id": "imp_01HZX0IM1A2B3C4D5E6F7G8H",
    "status": "in_progress",
    "submitted_count": 2,
    "completed_count": 0,
    "failed_count": 0,
    "nameserver_groups": [
      {
        "nameserver_one": "helena.ns.cloudflare.com",
        "nameserver_two": "idris.ns.cloudflare.com",
        "domains": [
          "acme-mail.com",
          "team-acme.com"
        ]
      }
    ],
    "failed": [
      {
        "domain": "bad-acme.com",
        "reason": "cloudflare_import_failed"
      }
    ],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:05:00Z"
  }
}

Authorizations

Authorization

string

header

default:Bearer pk_test_<your-test-key>

required

Your partner API key. Use pk_live_… against the live system or pk_test_… against the sandbox.

Body

application/json

domains

string[]

required

Required array length: 1 - 500 elements

Response

202 - application/json

Import job accepted.

data

object

required

Show child attributes

Last modified on June 16, 2026

Setting domain forwardingPoint a list of domains at one URL. The response starts an async job that returns per-domain success/fail results when complete.

Submitting an async Cloudflare import job

curl --request POST \
  --url https://api.peeker.ai/partner/v1/domains/import/jobs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domains": [
    "acme-mail.com",
    "team-acme.com"
  ]
}
'

{
  "data": {
    "id": "imp_01HZX0IM1A2B3C4D5E6F7G8H",
    "status": "in_progress",
    "submitted_count": 2,
    "completed_count": 0,
    "failed_count": 0,
    "nameserver_groups": [
      {
        "nameserver_one": "helena.ns.cloudflare.com",
        "nameserver_two": "idris.ns.cloudflare.com",
        "domains": [
          "acme-mail.com",
          "team-acme.com"
        ]
      }
    ],
    "failed": [
      {
        "domain": "bad-acme.com",
        "reason": "cloudflare_import_failed"
      }
    ],
    "created_at": "2026-05-08T12:00:00Z",
    "completed_at": "2026-05-08T12:05:00Z"
  }
}