API referenceDomains
Publish DNS records on Cloudflare
POST
/domains/{id}/dns/cloudflarePublishes an Amazon SES domain's DKIM, MAIL FROM and DMARC records in its zone on Cloudflare DNS, through a Cloudflare connection of the organization. Needs a setup token with Zone Read and DNS Write on the zone, used for this request only. Never overwrites a record: a name that holds a different value is reported as conflict, a receiving MX as manual (see dns_automation).
Authorization
apiKey AuthorizationBearer <token>
A project API key: Authorization: Bearer s0_…
In: header
Path Parameters
id*string
Length
1 <= length <= 64Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/domains/string/dns/cloudflare" \ -H "Content-Type: application/json" \ -d '{ "connection_id": "string", "setup_token": "string" }'{ "object": "domain", "id": "string", "name": "string", "status": "not_started", "created_at": "2019-08-24T14:15:22Z", "region": "string", "records": [ { "record": "SPF", "name": "string", "fqdn": "string", "type": "TXT", "value": "string", "ttl": "string", "priority": -9007199254740991, "status": "not_started" } ], "open_tracking": true, "click_tracking": true, "tls": "opportunistic", "capabilities": { "sending": "enabled", "receiving": "enabled" }, "connection_id": "string", "sending_connection": { "id": "string", "provider": "ses" }, "receiving_connection": { "id": "string", "provider": "ses" }, "custom_return_path": "string", "tracking_subdomain": "string", "configuration_set_name": "string", "tracking_status": "pending", "receiving": { "status": "disabled", "setup": { "status": "unsupported_region", "stack_update": { "stack_name": "string", "region": "string", "parameters": { "property1": "string", "property2": "string" }, "console_url": "string", "command": "string" }, "activate_rule_set": { "rule_set_name": "string", "command": "string" }, "checked_at": "2019-08-24T14:15:22Z" } }, "receiving_only": true, "dns_automation": { "provider": "route53", "status": "applied", "zone_name": "string", "checked_at": "2019-08-24T14:15:22Z", "records": [ { "record": "SPF", "name": "string", "type": "TXT", "result": "created" } ] }, "sending_restriction": { "status": "not_configured", "stack_update": { "stack_name": "string", "region": "string", "parameters": { "property1": "string", "property2": "string" }, "console_url": "string", "command": "string" } }}