Set up DNS with Cloudflare

Creates exactly Pidgely's records in the domain's Cloudflare zone with a Cloudflare API token (Zone → DNS → Edit, plus Zone → Zone → Read). Idempotent, never touches unrelated records, merges into an existing SPF record and keeps an existing DMARC policy. The token is write-only: it is used for this request and never stored, logged or returned. A DNS check runs right after.

Creates or updates exactly Pidgely's records in the domain's Cloudflare zone with a Cloudflare API token (permission Zone → DNS → Edit, plus Zone → Zone → Read to find the zone). Idempotent: running it again changes nothing. Unrelated records are never touched; an existing SPF record at the return path gets Pidgely's include: merged in (never a second SPF record), and an existing DMARC policy is kept. A DNS check is scheduled right after. The token is used for this request only: it is never stored or logged. Errors (422, field api_token): cloudflare_invalid_token, cloudflare_missing_permission, cloudflare_zone_not_found; 502 cloudflare_unavailable. 10 requests per minute per organization.

Authorization: Bearer pdg_…. An API key with full_access. A sending_access key gets 401 restricted_api_key.

#Path parameters

#Body parameters

JSON object.

#Request

This endpoint is in the Node.js SDK; the other SDKs don't cover it yet, so call it over HTTP from them.

import { Pidgely } from 'pidgely';

const pidgely = new Pidgely(process.env.PIDGELY_API_KEY);

const { data, error } = await pidgely.domains.setupCloudflare('0199d7f0-1c2b-7e4d-a5f6-0b9c8d7e6f51', {
  apiToken: 'your-cloudflare-api-token',
});
console.log(data ?? error);

curl -X POST 'https://api.pidgely.com/domains/0199d7f0-1c2b-7e4d-a5f6-0b9c8d7e6f51/dns-provider/cloudflare' \
  -H "Authorization: Bearer $PIDGELY_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "api_token": "your-cloudflare-api-token"
}'

#Response

200 OK

{
  "object": "cloudflare_setup",
  "zone": "acme.com",
  "records": [
    {
      "purpose": "dkim",
      "type": "TXT",
      "name": "pdg202610._domainkey.send.acme.com",
      "content": "v=DKIM1; k=rsa; p=MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA…",
      "action": "created"
    },
    {
      "purpose": "return_path",
      "type": "MX",
      "name": "bounces.send.acme.com",
      "content": "mta.pidgely.com",
      "priority": 10,
      "action": "created"
    },
    {
      "purpose": "spf",
      "type": "TXT",
      "name": "bounces.send.acme.com",
      "content": "v=spf1 include:_spf.mta.pidgely.com ~all",
      "action": "created"
    },
    {
      "purpose": "dmarc",
      "type": "TXT",
      "name": "_dmarc.send.acme.com",
      "content": "v=DMARC1; p=quarantine",
      "action": "kept"
    }
  ]
}

#Response fields

#Errors

Errors have the shape {"statusCode", "name", "message"}. See Errors for the full list.