Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare DNS DNS Batch Operations API

2 actions 2 updates phrasing extends openapi/cloudflare-dns-batch-operations-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Cloudflare's API. It is a proposal applied on top of the contract, not a document Cloudflare publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/zones/{zone_id}/dns_records/batch'].post

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Cloudflare DNS DNS Batch Operations API
  version: 1.0.0
extends: openapi/cloudflare-dns-batch-operations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/zones/{zone_id}/dns_records/batch'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply many DNS record changes in one batch
      effect: write
      questions:
      - How do I create, update and delete many DNS records in a single request?
      - In what order are deletes, patches, puts and posts applied in a DNS batch?
      instructions:
      - text: Run a batch of DNS record changes on zone {zone_id}.
        slots:
          zone_id: path.zone_id
      - text: In zone {zone_id}, delete {deletes} and create {posts} in one batch.
        slots:
          zone_id: path.zone_id
          deletes: requestBody.deletes
          posts: requestBody.posts
      - text: 'Batch-patch these DNS records in {zone_id}: {patches}.'
        slots:
          zone_id: path.zone_id
          patches: requestBody.patches
      method: generated
      generated: '2026-09-26'