Cloudflare · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Cloudflare DNS DNS Record Scanning API

4 actions 4 updates phrasing extends openapi/cloudflare-dns-record-scanning-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 4

$.info
$.paths['/zones/{zone_id}/dns_records/scan/trigger'].post
$.paths['/zones/{zone_id}/dns_records/scan/review'].get
$.paths['/zones/{zone_id}/dns_records/scan/review'].post

OpenAPI Overlay

Raw ↑ 
# 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 Record Scanning API
  version: 1.0.0
extends: openapi/cloudflare-dns-record-scanning-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: 3
- target: $.paths['/zones/{zone_id}/dns_records/scan/trigger'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a scan for a domain's DNS records
      effect: write
      questions:
      - How do I get Cloudflare to scan my domain for its existing DNS records?
      - Can I kick off a background DNS record scan after moving a domain over?
      instructions:
      - text: Start a DNS record scan for zone {zone}.
        slots:
          zone: path.zone_id
      - text: Trigger a background scan to discover common DNS records on zone {zone}.
        slots:
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_records/scan/review'].get
  update:
    x-apievangelist-phrasing:
      intent: Review DNS records found by a scan
      effect: read
      questions:
      - What DNS records did the latest scan find on my domain?
      - Can I review scanned records before they are added to the zone?
      instructions:
      - text: Show the DNS records the most recent scan found for zone {zone}.
        slots:
          zone: path.zone_id
      - text: List scan results awaiting review on zone {zone}.
        slots:
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/zones/{zone_id}/dns_records/scan/review'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept scanned DNS records into a zone
      effect: write
      questions:
      - How do I add the records a DNS scan discovered to my zone?
      - Can I accept scanned DNS records once I've reviewed them?
      instructions:
      - text: Accept the scanned DNS records and add them to zone {zone}.
        slots:
          zone: path.zone_id
      - text: Import the reviewed scan results into zone {zone}.
        slots:
          zone: path.zone_id
      method: generated
      generated: '2026-09-26'