# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Cloudflare Zones API version: 1.0.0 extends: openapi/cloudflare-zones-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: 508 - target: $.paths['/zones'].get update: x-apievangelist-phrasing: intent: List and filter my zones effect: read questions: - How do I see every domain I have added to Cloudflare? - Can I filter my zones by status, like only the ones still pending? - Which zones belong to a particular account? instructions: - text: List all my zones. - text: Show my zones named {name}. slots: name: query.name - text: List zones with status {status} for account {account_id}. slots: status: query.status account_id: query.account.id method: generated generated: '2026-09-26' - target: $.paths['/zones'].post update: x-apievangelist-phrasing: intent: Add a new domain as a zone effect: write questions: - How do I add a new domain to my account so it can be proxied? - Can I create a partial (CNAME setup) zone instead of a full one? instructions: - text: Add {name} as a new zone under account {account}. slots: name: requestBody.name account: requestBody.account - text: Create a {type} zone for domain {name} in account {account}. slots: type: requestBody.type name: requestBody.name account: requestBody.account method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps'].get update: x-apievangelist-phrasing: intent: List Access applications in a zone effect: read questions: - What Access applications are protecting this zone? - Can I see all the self-hosted apps Access guards on one domain? instructions: - text: List the Access applications on zone {identifier}. slots: identifier: path.identifier - text: Show every Access app configured for zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps'].post update: x-apievangelist-phrasing: intent: Add an Access application to a zone effect: write questions: - How do I put a new application behind Access on my zone? - Can I register a bookmark application in zone-level Access? instructions: - text: Add a new Access application to zone {identifier}. slots: identifier: path.identifier - text: Register a bookmark app with Access on zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{app_id}'].get update: x-apievangelist-phrasing: intent: Get one Access application's details effect: read questions: - Where can I see the configuration of a single Access app on my zone? - What domain and session settings does this Access application use? instructions: - text: Show Access application {app_id} on zone {identifier}. slots: app_id: path.app_id identifier: path.identifier - text: Fetch the settings of app {app_id} in zone {identifier}. slots: app_id: path.app_id identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{app_id}'].put update: x-apievangelist-phrasing: intent: Update an Access application effect: write questions: - How do I change the configuration of an existing Access application? - Can I edit a bookmark app I already added to zone-level Access? instructions: - text: Update Access application {app_id} on zone {identifier}. slots: app_id: path.app_id identifier: path.identifier - text: Change the settings of existing app {app_id} in zone {identifier}. slots: app_id: path.app_id identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{app_id}'].delete update: x-apievangelist-phrasing: intent: Delete an Access application effect: destructive questions: - How do I stop protecting an app with Access and remove it from my zone? - What happens when I delete an application from zone-level Access? instructions: - text: Delete Access application {app_id} from zone {identifier}. slots: app_id: path.app_id identifier: path.identifier - text: Remove app {app_id} from Access on zone {identifier}. slots: app_id: path.app_id identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{app_id}/revoke_tokens'].post update: x-apievangelist-phrasing: intent: Revoke all tokens issued for an app effect: destructive questions: - How do I force everyone to log in again to one Access application? - Can I invalidate every token that was issued for a single app? instructions: - text: Revoke all tokens issued for Access app {app_id} on zone {identifier}. slots: app_id: path.app_id identifier: path.identifier - text: Log everyone out of application {app_id} in zone {identifier}. slots: app_id: path.app_id identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{app_id}/user_policy_checks'].get update: x-apievangelist-phrasing: intent: Test whether users can reach an app effect: read questions: - How can I check if a specific user would be allowed into an Access app? - Is there a way to test my Access policies before rolling them out? instructions: - text: Test the Access policies of app {app_id} on zone {identifier}. slots: app_id: path.app_id identifier: path.identifier - text: Check which users pass the policy checks for app {app_id} in zone {identifier}. slots: app_id: path.app_id identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid}/ca'].get update: x-apievangelist-phrasing: intent: Get an app's short-lived certificate CA effect: read questions: - Where do I find the public key of the short-lived certificate CA for an SSH app? - Does this Access application already have a short-lived certificate CA? instructions: - text: Get the short-lived certificate CA for app {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Show the CA public key for Access app {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid}/ca'].post update: x-apievangelist-phrasing: intent: Create a short-lived certificate CA for an app effect: write questions: - How do I generate a short-lived certificate CA so users get ephemeral certs? - Can I create a new CA and public key for one Access application? instructions: - text: Create a short-lived certificate CA for app {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Generate a new CA and public key for Access app {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid}/ca'].delete update: x-apievangelist-phrasing: intent: Delete an app's short-lived certificate CA effect: destructive questions: - How do I remove the short-lived certificate CA from an application? - What breaks if I delete the CA used for short-lived certificates? instructions: - text: Delete the short-lived certificate CA of app {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Remove the ephemeral cert CA from Access app {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid}/policies'].get update: x-apievangelist-phrasing: intent: List Access policies for an application effect: read questions: - Which Access policies are attached to this application? - Can I see the allow and block rules configured for one app? instructions: - text: List the Access policies for app {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Show every policy on Access application {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid}/policies'].post update: x-apievangelist-phrasing: intent: Create an Access policy for an application effect: write questions: - How do I add a rule that decides who can reach an Access app? - Can a new policy require approval or a purpose justification before access? instructions: - text: Create an Access policy named {name} with decision {decision} on app {uuid} in zone {identifier}. slots: name: requestBody.name decision: requestBody.decision uuid: path.uuid identifier: path.identifier - text: Add policy {name} to app {uuid} on zone {identifier} including {include}. slots: name: requestBody.name uuid: path.uuid identifier: path.identifier include: requestBody.include - text: Create a {decision} policy {name} for app {uuid} in zone {identifier} that requires approval {approval_required}. slots: decision: requestBody.decision name: requestBody.name uuid: path.uuid identifier: path.identifier approval_required: requestBody.approval_required method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid1}/policies/{uuid}'].get update: x-apievangelist-phrasing: intent: Get one Access policy effect: read questions: - How can I view the include, exclude and require rules of a single policy? - What decision does a particular Access policy make? instructions: - text: Show Access policy {uuid} of app {uuid1} on zone {identifier}. slots: uuid: path.uuid uuid1: path.uuid1 identifier: path.identifier - text: Fetch policy {uuid} for application {uuid1} in zone {identifier}. slots: uuid: path.uuid uuid1: path.uuid1 identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid1}/policies/{uuid}'].put update: x-apievangelist-phrasing: intent: Update an Access policy effect: write questions: - How do I change who an existing Access policy lets in? - Can I change the precedence of a policy I already created? instructions: - text: Update Access policy {uuid} on app {uuid1} in zone {identifier} to decision {decision}. slots: uuid: path.uuid uuid1: path.uuid1 identifier: path.identifier decision: requestBody.decision - text: Rename policy {uuid} of app {uuid1} on zone {identifier} to {name} and include {include}. slots: uuid: path.uuid uuid1: path.uuid1 identifier: path.identifier name: requestBody.name include: requestBody.include - text: Set the precedence of policy {uuid} for app {uuid1} in zone {identifier} to {precedence}. slots: uuid: path.uuid uuid1: path.uuid1 identifier: path.identifier precedence: requestBody.precedence method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/{uuid1}/policies/{uuid}'].delete update: x-apievangelist-phrasing: intent: Delete an Access policy effect: destructive questions: - How do I remove a policy from an Access application? - Will deleting an Access policy change who can reach the app? instructions: - text: Delete Access policy {uuid} from app {uuid1} on zone {identifier}. slots: uuid: path.uuid uuid1: path.uuid1 identifier: path.identifier - text: Remove policy {uuid} of application {uuid1} in zone {identifier}. slots: uuid: path.uuid uuid1: path.uuid1 identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/apps/ca'].get update: x-apievangelist-phrasing: intent: List short-lived certificate CAs in a zone effect: read questions: - Which of my Access apps in this zone have short-lived certificate CAs? - Can I get all the CA public keys at once for SSH short-lived certs? instructions: - text: List all short-lived certificate CAs on zone {identifier}. slots: identifier: path.identifier - text: Show every ephemeral cert CA and public key in zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/certificates'].get update: x-apievangelist-phrasing: intent: List Access mTLS root certificates effect: read questions: - What mTLS root certificates has Access got for my zone? - Can I see every client-auth root CA uploaded to zone-level Access? instructions: - text: List the Access mTLS certificates on zone {identifier}. slots: identifier: path.identifier - text: Show all mTLS root certs Access uses in zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/certificates'].post update: x-apievangelist-phrasing: intent: Add an mTLS root certificate to Access effect: write questions: - How do I upload a root CA so Access can authenticate devices with mTLS? - Can I link a new mTLS certificate to specific hostnames when adding it? instructions: - text: Add mTLS root certificate {name} with PEM {certificate} to Access on zone {identifier}. slots: name: requestBody.name certificate: requestBody.certificate identifier: path.identifier - text: Upload root cert {name} to zone {identifier} for hostnames {associated_hostnames} using {certificate}. slots: name: requestBody.name identifier: path.identifier associated_hostnames: requestBody.associated_hostnames certificate: requestBody.certificate method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/certificates/{uuid}'].get update: x-apievangelist-phrasing: intent: Get one Access mTLS certificate effect: read questions: - How can I look up a single mTLS root certificate in Access? - Which hostnames is this mTLS certificate associated with? instructions: - text: Show Access mTLS certificate {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Fetch mTLS root cert {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/certificates/{uuid}'].put update: x-apievangelist-phrasing: intent: Update an Access mTLS certificate effect: write questions: - How do I change which hostnames an Access mTLS certificate applies to? - Can I rename an mTLS root certificate I already uploaded? instructions: - text: Associate mTLS certificate {uuid} on zone {identifier} with hostnames {associated_hostnames}. slots: uuid: path.uuid identifier: path.identifier associated_hostnames: requestBody.associated_hostnames - text: Rename mTLS cert {uuid} in zone {identifier} to {name} for hostnames {associated_hostnames}. slots: uuid: path.uuid identifier: path.identifier name: requestBody.name associated_hostnames: requestBody.associated_hostnames method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/certificates/{uuid}'].delete update: x-apievangelist-phrasing: intent: Delete an Access mTLS certificate effect: destructive questions: - How do I remove an mTLS root certificate from Access? - What happens to devices using a root cert once I delete it from Access? instructions: - text: Delete Access mTLS certificate {uuid} from zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Remove mTLS root cert {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/certificates/settings'].get update: x-apievangelist-phrasing: intent: List mTLS hostname settings effect: read questions: - Which hostnames in my zone have mTLS client certificate forwarding turned on? - Can I see the per-hostname mTLS settings Access applies? instructions: - text: List the mTLS hostname settings for zone {identifier}. slots: identifier: path.identifier - text: Show how mTLS is configured per hostname in zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/certificates/settings'].put update: x-apievangelist-phrasing: intent: Update mTLS hostname settings effect: write questions: - How do I change mTLS behavior for individual hostnames in a zone? - Can I turn on China network or client cert forwarding per hostname? instructions: - text: Replace the mTLS hostname settings on zone {identifier} with {settings}. slots: identifier: path.identifier settings: requestBody.settings - text: Update per-hostname mTLS settings in zone {identifier} to {settings}. slots: identifier: path.identifier settings: requestBody.settings method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/groups'].get update: x-apievangelist-phrasing: intent: List Access groups in a zone effect: read questions: - What Access groups have been defined for my zone? - Can I see the reusable user groups that zone-level Access policies reference? instructions: - text: List the Access groups on zone {identifier}. slots: identifier: path.identifier - text: Show every Access group in zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/groups'].post update: x-apievangelist-phrasing: intent: Create an Access group effect: write questions: - How do I make a reusable group of users for Access policies? - Can a new Access group exclude some people while including others? instructions: - text: Create Access group {name} on zone {identifier} including {include}. slots: name: requestBody.name identifier: path.identifier include: requestBody.include - text: Make group {name} in zone {identifier} that includes {include} and excludes {exclude}. slots: name: requestBody.name identifier: path.identifier include: requestBody.include exclude: requestBody.exclude method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/groups/{uuid}'].get update: x-apievangelist-phrasing: intent: Get one Access group effect: read questions: - How can I see who belongs to one Access group? - What include and require rules define a particular Access group? instructions: - text: Show Access group {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Fetch the rules of group {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/groups/{uuid}'].put update: x-apievangelist-phrasing: intent: Update an Access group effect: write questions: - How do I change the membership rules of an existing Access group? - Can I add a require rule to a group I already made? instructions: - text: Update Access group {uuid} on zone {identifier} to include {include}. slots: uuid: path.uuid identifier: path.identifier include: requestBody.include - text: Rename group {uuid} in zone {identifier} to {name} with include rules {include}. slots: uuid: path.uuid identifier: path.identifier name: requestBody.name include: requestBody.include method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/groups/{uuid}'].delete update: x-apievangelist-phrasing: intent: Delete an Access group effect: destructive questions: - How do I get rid of an Access group I no longer use? - Does deleting an Access group affect the policies that reference it? instructions: - text: Delete Access group {uuid} from zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Remove group {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/identity_providers'].get update: x-apievangelist-phrasing: intent: List Access identity providers effect: read questions: - Which login methods are set up for Access on my zone? - Can I see every identity provider configured for zone-level Access? instructions: - text: List the identity providers for Access on zone {identifier}. slots: identifier: path.identifier - text: Show all login methods configured in zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/identity_providers'].post update: x-apievangelist-phrasing: intent: Add an identity provider to Access effect: write questions: - How do I connect a new SSO login method to Access for a zone? - Can I add a one-time PIN or SAML login to zone-level Access? instructions: - text: Add a new identity provider to Access on zone {identifier}. slots: identifier: path.identifier - text: Connect an SSO login method to zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/identity_providers/{uuid}'].get update: x-apievangelist-phrasing: intent: Get one Access identity provider effect: read questions: - How can I view the configuration of a single login method? - What settings does this identity provider use in Access? instructions: - text: Show identity provider {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Fetch the config of login method {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/identity_providers/{uuid}'].put update: x-apievangelist-phrasing: intent: Update an Access identity provider effect: write questions: - How do I change the settings of a login method already in Access? - Can I rotate the client secret on an existing identity provider? instructions: - text: Update identity provider {uuid} on zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Change the configuration of login method {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/identity_providers/{uuid}'].delete update: x-apievangelist-phrasing: intent: Delete an Access identity provider effect: destructive questions: - How do I remove a login method from Access? - What happens to users who sign in with an identity provider I delete? instructions: - text: Delete identity provider {uuid} from zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Remove login method {uuid} from Access in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/organizations'].get update: x-apievangelist-phrasing: intent: Get my Zero Trust organization config effect: read questions: - What is the auth domain of my Zero Trust organization? - Where can I see the login page design and seat expiry for my organization? instructions: - text: Show the Zero Trust organization settings for zone {identifier}. slots: identifier: path.identifier - text: Get my Zero Trust org config via zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/organizations'].put update: x-apievangelist-phrasing: intent: Update my Zero Trust organization effect: write questions: - How do I change the login page design for my Zero Trust organization? - Can I make the dashboard read-only for my organization's Zero Trust settings? instructions: - text: Rename the Zero Trust organization on zone {identifier} to {name}. slots: identifier: path.identifier name: requestBody.name - text: Set the auth domain of my organization on zone {identifier} to {auth_domain}. slots: identifier: path.identifier auth_domain: requestBody.auth_domain - text: Expire inactive user seats after {user_seat_expiration_inactive_time} for zone {identifier}. slots: user_seat_expiration_inactive_time: requestBody.user_seat_expiration_inactive_time identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/organizations'].post update: x-apievangelist-phrasing: intent: Set up a Zero Trust organization effect: write questions: - How do I set up a Zero Trust organization for the first time? - What auth domain do I need to create my organization? instructions: - text: Create Zero Trust organization {name} with auth domain {auth_domain} on zone {identifier}. slots: name: requestBody.name auth_domain: requestBody.auth_domain identifier: path.identifier - text: Set up my organization on zone {identifier} named {name} at {auth_domain}. slots: identifier: path.identifier name: requestBody.name auth_domain: requestBody.auth_domain method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/organizations/revoke_user'].post update: x-apievangelist-phrasing: intent: Revoke all Access tokens for a user effect: destructive questions: - How do I cut off one person's access to every application at once? - Can I sign out a departing employee from all Access apps? instructions: - text: Revoke all Access tokens for {email} on zone {identifier}. slots: email: requestBody.email identifier: path.identifier - text: Kick user {email} out of every app in zone {identifier}. slots: email: requestBody.email identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/service_tokens'].get update: x-apievangelist-phrasing: intent: List Access service tokens effect: read questions: - Which service tokens exist for machine access to my zone? - Can I see all the non-human credentials Access has issued? instructions: - text: List the service tokens on zone {identifier}. slots: identifier: path.identifier - text: Show every Access service token in zone {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/service_tokens'].post update: x-apievangelist-phrasing: intent: Create an Access service token effect: write questions: - How do I give a script or bot credentials to get past Access? - When can I see the client secret of a new service token? instructions: - text: Create service token {name} on zone {identifier}. slots: name: requestBody.name identifier: path.identifier - text: Generate a service token {name} valid for {duration} in zone {identifier}. slots: name: requestBody.name duration: requestBody.duration identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/service_tokens/{uuid}'].put update: x-apievangelist-phrasing: intent: Update an Access service token effect: write questions: - How do I rename or change the lifetime of an existing service token? - Can I extend how long a service token lasts? instructions: - text: Rename service token {uuid} on zone {identifier} to {name}. slots: uuid: path.uuid identifier: path.identifier name: requestBody.name - text: Set the duration of service token {uuid} in zone {identifier} to {duration}. slots: uuid: path.uuid identifier: path.identifier duration: requestBody.duration method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/access/service_tokens/{uuid}'].delete update: x-apievangelist-phrasing: intent: Delete an Access service token effect: destructive questions: - How do I revoke a service token a machine was using? - What happens to automated clients when I delete their service token? instructions: - text: Delete service token {uuid} from zone {identifier}. slots: uuid: path.uuid identifier: path.identifier - text: Remove Access service token {uuid} in zone {identifier}. slots: uuid: path.uuid identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/dns_analytics/report'].get update: x-apievangelist-phrasing: intent: Get summarized DNS analytics effect: read questions: - How many DNS queries did my zone answer over a time period? - Can I break DNS query totals down by dimensions like query type or response code? instructions: - text: Summarize DNS metrics {metrics} for zone {identifier} since {since}. slots: metrics: query.metrics identifier: path.identifier since: query.since - text: Report DNS {metrics} by {dimensions} for zone {identifier} between {since} and {until}. slots: metrics: query.metrics dimensions: query.dimensions identifier: path.identifier since: query.since until: query.until method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/dns_analytics/report/bytime'].get update: x-apievangelist-phrasing: intent: Get DNS analytics over time effect: read questions: - How has DNS query volume on my zone changed hour by hour? - Can I chart DNS metrics in time buckets of my choosing? instructions: - text: Chart DNS {metrics} for zone {identifier} grouped every {time_delta}. slots: metrics: query.metrics identifier: path.identifier time_delta: query.time_delta - text: Show DNS query counts over time for zone {identifier} from {since} to {until}. slots: identifier: path.identifier since: query.since until: query.until method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/subscription'].get update: x-apievangelist-phrasing: intent: Get a zone's subscription effect: read questions: - What plan and add-ons is my zone subscribed to? - When does the current billing period for this zone end? instructions: - text: Show the subscription details for zone {identifier}. slots: identifier: path.identifier - text: Tell me which plan zone {identifier} is on. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/subscription'].put update: x-apievangelist-phrasing: intent: Change a zone's plan or add-ons effect: write questions: - How do I upgrade the plan on an existing zone subscription? - Can I switch a zone's billing frequency to yearly? instructions: - text: Change the subscription of zone {identifier} to rate plan {rate_plan}. slots: identifier: path.identifier rate_plan: requestBody.rate_plan - text: Switch zone {identifier} billing frequency to {frequency}. slots: identifier: path.identifier frequency: requestBody.frequency method: generated generated: '2026-09-26' - target: $.paths['/zones/{identifier}/subscription'].post update: x-apievangelist-phrasing: intent: Subscribe a zone to a plan effect: write questions: - How do I start a paid plan subscription on a zone that has none? - Can I create a subscription for an add-on on my zone? instructions: - text: Create a subscription for zone {identifier} on rate plan {rate_plan}. slots: identifier: path.identifier rate_plan: requestBody.rate_plan - text: Start a {frequency} subscription for zone {identifier} with plan {rate_plan}. slots: frequency: requestBody.frequency identifier: path.identifier rate_plan: requestBody.rate_plan method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}'].get update: x-apievangelist-phrasing: intent: Get a zone's details effect: read questions: - How do I look up the status and nameservers of one zone? - What plan and account is a particular zone on? instructions: - text: Show details for zone {zone_id}. slots: zone_id: path.zone_id - text: Get the nameservers and status of zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}'].delete update: x-apievangelist-phrasing: intent: Delete a zone effect: destructive questions: - How do I remove a domain from my account entirely? - Is deleting a zone reversible? instructions: - text: Delete zone {zone_id}. slots: zone_id: path.zone_id - text: Remove domain zone {zone_id} from my account. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}'].patch update: x-apievangelist-phrasing: intent: Edit a zone property effect: write questions: - How do I pause Cloudflare on one domain? - Can I change a zone's type or set vanity nameservers? instructions: - text: 'Pause zone {zone_id}: set paused to {paused}.' slots: zone_id: path.zone_id paused: requestBody.paused - text: Change zone {zone_id} type to {type}. slots: zone_id: path.zone_id type: requestBody.type - text: Set vanity name servers {vanity_name_servers} on zone {zone_id}. slots: vanity_name_servers: requestBody.vanity_name_servers zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/acm/total_tls'].get update: x-apievangelist-phrasing: intent: Get Total TLS settings effect: read questions: - Is Total TLS turned on for my zone? - Which certificate authority does Total TLS use for my hostnames? instructions: - text: Show the Total TLS settings for zone {zone_id}. slots: zone_id: path.zone_id - text: Check whether Total TLS is enabled on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/acm/total_tls'].post update: x-apievangelist-phrasing: intent: Turn Total TLS on or off effect: write questions: - How do I automatically issue certificates for every proxied hostname? - Can I choose the certificate authority when enabling Total TLS? instructions: - text: Set Total TLS on zone {zone_id} to enabled {enabled}. slots: zone_id: path.zone_id enabled: requestBody.enabled - text: Enable Total TLS on zone {zone_id} using CA {certificate_authority} ({enabled}). slots: zone_id: path.zone_id certificate_authority: requestBody.certificate_authority enabled: requestBody.enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/activation_check'].put update: x-apievangelist-phrasing: intent: Rerun a pending zone's activation check effect: write questions: - How do I make Cloudflare recheck my nameservers after I changed them? - How often can I trigger an activation check on a free zone? instructions: - text: Rerun the activation check for pending zone {zone_id}. slots: zone_id: path.zone_id - text: Recheck nameserver activation on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/analytics/latency'].get update: x-apievangelist-phrasing: intent: Get Argo latency analytics for a zone effect: read questions: - How much has Argo improved response latency on my zone? - Can I get Argo latency data as a histogram? instructions: - text: Show Argo latency analytics for zone {zone_id}. slots: zone_id: path.zone_id - text: Get Argo latency for zone {zone_id} in {bins} bins. slots: zone_id: path.zone_id bins: query.bins method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/analytics/latency/colos'].get update: x-apievangelist-phrasing: intent: Get Argo analytics by data center effect: read questions: - Which Cloudflare data centers see the biggest Argo speedup for my zone? - Can I compare Argo performance across PoPs? instructions: - text: Show Argo analytics per PoP for zone {zone_id}. slots: zone_id: path.zone_id - text: Break down Argo latency by data center for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/configuration'].get update: x-apievangelist-phrasing: intent: Get API Shield configuration effect: read questions: - What auth ID characteristics does API Shield use to identify sessions on my zone? - Can I read just some API Shield configuration properties? instructions: - text: Show the API Shield configuration for zone {zone_id}. slots: zone_id: path.zone_id - text: Get API Shield properties {properties} on zone {zone_id}. slots: properties: query.properties zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/configuration'].put update: x-apievangelist-phrasing: intent: Set API Shield session identifiers effect: write questions: - How do I tell API Shield which header or cookie identifies an API session? - Can I change the auth ID characteristics for my zone? instructions: - text: Set API Shield auth ID characteristics on zone {zone_id} to {auth_id_characteristics}. slots: zone_id: path.zone_id auth_id_characteristics: requestBody.auth_id_characteristics - text: Configure session identifiers {auth_id_characteristics} for API Shield on zone {zone_id}. slots: auth_id_characteristics: requestBody.auth_id_characteristics zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/discovery'].get update: x-apievangelist-phrasing: intent: Export discovered API operations as OpenAPI effect: read questions: - Can API Shield give me an OpenAPI file of the endpoints it discovered on my zone? - How do I download discovered API traffic as OpenAPI schemas? instructions: - text: Export the discovered operations on zone {zone_id} as OpenAPI. slots: zone_id: path.zone_id - text: Give me OpenAPI schemas for everything API Discovery found on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/discovery/operations'].get update: x-apievangelist-phrasing: intent: List API endpoints discovered on a zone effect: read questions: - Which API endpoints has API Discovery found in my traffic? - Can I filter discovered endpoints to only those still awaiting review? instructions: - text: List the discovered API operations on zone {zone_id}. slots: zone_id: path.zone_id - text: Show discovered endpoints on zone {zone_id} for host {host} with state {state}. slots: zone_id: path.zone_id host: query.host state: query.state - text: List discovered {method} operations on zone {zone_id} matching {endpoint}. slots: method: query.method zone_id: path.zone_id endpoint: query.endpoint method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/discovery/operations'].patch update: x-apievangelist-phrasing: intent: Bulk update the state of discovered endpoints effect: write questions: - How do I mark many discovered endpoints as reviewed at once? - Can I ignore a batch of discovered API operations in one call? instructions: - text: Update the review state of several discovered operations on zone {zone_id}. slots: zone_id: path.zone_id - text: Bulk-mark discovered endpoints on zone {zone_id} as reviewed. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/discovery/operations/{operation_id}'].patch update: x-apievangelist-phrasing: intent: Update the state of one discovered endpoint effect: write questions: - How do I mark a single discovered endpoint as ignored? - What review states can one discovered operation be set to? instructions: - text: Set discovered operation {operation_id} on zone {zone_id} to state {state}. slots: operation_id: path.operation_id zone_id: path.zone_id state: requestBody.state - text: Mark only discovered endpoint {operation_id} in zone {zone_id} as {state}. slots: operation_id: path.operation_id zone_id: path.zone_id state: requestBody.state method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/operations'].get update: x-apievangelist-phrasing: intent: List managed API operations on a zone effect: read questions: - Which API endpoints have I saved to Endpoint Management? - Can I list saved operations along with features like thresholds or schema info? instructions: - text: List the saved API operations in Endpoint Management for zone {zone_id}. slots: zone_id: path.zone_id - text: Show saved operations on zone {zone_id} for host {host} with feature {feature}. slots: zone_id: path.zone_id host: query.host feature: query.feature method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/operations'].post update: x-apievangelist-phrasing: intent: Add API operations to Endpoint Management effect: write questions: - How do I add my API endpoints to API Shield so they can be protected? - Can saved endpoints include path variables? instructions: - text: Add API operations to Endpoint Management on zone {zone_id}. slots: zone_id: path.zone_id - text: Save a batch of new endpoints to API Shield for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/operations/{operation_id}'].get update: x-apievangelist-phrasing: intent: Get one managed API operation effect: read questions: - How can I see the details of a single endpoint saved in API Shield? - Can I include feature data like schema info when fetching one operation? instructions: - text: Show saved API operation {operation_id} on zone {zone_id}. slots: operation_id: path.operation_id zone_id: path.zone_id - text: Get operation {operation_id} in zone {zone_id} with feature {feature}. slots: operation_id: path.operation_id zone_id: path.zone_id feature: query.feature method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/operations/{operation_id}'].delete update: x-apievangelist-phrasing: intent: Remove an operation from Endpoint Management effect: destructive questions: - How do I stop tracking an endpoint in API Shield Endpoint Management? - What happens to protections on an endpoint when I delete its saved operation? instructions: - text: Delete saved API operation {operation_id} from zone {zone_id}. slots: operation_id: path.operation_id zone_id: path.zone_id - text: Remove endpoint {operation_id} from Endpoint Management on zone {zone_id}. slots: operation_id: path.operation_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation'].get update: x-apievangelist-phrasing: intent: Get schema validation settings for an operation effect: read questions: - What mitigation action applies when a request to one endpoint fails schema validation? - Does a specific operation override the zone's schema validation action? instructions: - text: Show schema validation settings for operation {operation_id} on zone {zone_id}. slots: operation_id: path.operation_id zone_id: path.zone_id - text: Get the validation mitigation action of endpoint {operation_id} in zone {zone_id}. slots: operation_id: path.operation_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation'].put update: x-apievangelist-phrasing: intent: Set schema validation action for an operation effect: write questions: - How do I block invalid requests to only one endpoint? - Can I set a single operation's schema validation to log instead of block? instructions: - text: Set the schema validation action for operation {operation_id} on zone {zone_id} to {mitigation_action}. slots: operation_id: path.operation_id zone_id: path.zone_id mitigation_action: requestBody.mitigation_action - text: Make endpoint {operation_id} in zone {zone_id} {mitigation_action} on invalid requests. slots: operation_id: path.operation_id zone_id: path.zone_id mitigation_action: requestBody.mitigation_action method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/operations/schema_validation'].patch update: x-apievangelist-phrasing: intent: Set schema validation for many operations effect: write questions: - How do I change schema validation actions for several endpoints in one request? - Can I bulk-update per-operation validation settings? instructions: - text: Update schema validation settings for multiple operations on zone {zone_id}. slots: zone_id: path.zone_id - text: Bulk-set per-endpoint validation actions on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/schemas'].get update: x-apievangelist-phrasing: intent: Export managed operations as OpenAPI effect: read questions: - Can I download my saved API Shield endpoints as an OpenAPI document? - Is there a way to export saved operations with their thresholds as OpenAPI? instructions: - text: Export the saved operations on zone {zone_id} as OpenAPI schemas. slots: zone_id: path.zone_id - text: Give me OpenAPI for saved endpoints on host {host} in zone {zone_id} with feature {feature}. slots: host: query.host zone_id: path.zone_id feature: query.feature method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/settings/schema_validation'].get update: x-apievangelist-phrasing: intent: Get zone-wide schema validation settings effect: read questions: - What happens by default on my zone when an API request fails schema validation? - Is there a zone-wide override for schema validation actions? instructions: - text: Show the zone-level schema validation settings for zone {zone_id}. slots: zone_id: path.zone_id - text: Get the default validation mitigation action on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/settings/schema_validation'].put update: x-apievangelist-phrasing: intent: Replace zone-wide schema validation settings effect: write questions: - How do I set the default action for requests that fail schema validation on my zone? - Can I replace both the default and override validation actions at once? instructions: - text: Set the default schema validation action on zone {zone_id} to {validation_default_mitigation_action}. slots: zone_id: path.zone_id validation_default_mitigation_action: requestBody.validation_default_mitigation_action - text: 'Replace zone {zone_id} validation settings: default {validation_default_mitigation_action}, override {validation_override_mitigation_action}.' slots: zone_id: path.zone_id validation_default_mitigation_action: requestBody.validation_default_mitigation_action validation_override_mitigation_action: requestBody.validation_override_mitigation_action method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/settings/schema_validation'].patch update: x-apievangelist-phrasing: intent: Partially update zone schema validation effect: write questions: - Can I change only the override action for schema validation without touching the default? - How do I temporarily disable schema validation mitigation across the whole zone? instructions: - text: Patch zone {zone_id} to override schema validation with {validation_override_mitigation_action}. slots: zone_id: path.zone_id validation_override_mitigation_action: requestBody.validation_override_mitigation_action - text: Change just the validation override on zone {zone_id} to {validation_override_mitigation_action}. slots: zone_id: path.zone_id validation_override_mitigation_action: requestBody.validation_override_mitigation_action method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/user_schemas'].get update: x-apievangelist-phrasing: intent: List uploaded API schemas effect: read questions: - What OpenAPI schemas have I uploaded to API Shield for my zone? - Can I list only the schemas that have validation enabled? instructions: - text: List the schemas uploaded to zone {zone_id}. slots: zone_id: path.zone_id - text: Show schemas on zone {zone_id} with validation enabled {validation_enabled}. slots: zone_id: path.zone_id validation_enabled: query.validation_enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/user_schemas'].post update: x-apievangelist-phrasing: intent: Upload an API schema for validation effect: write questions: - How do I upload an OpenAPI file so API Shield can validate requests? - Can I upload a schema without turning validation on yet? instructions: - text: Upload schema file {file} of kind {kind} to zone {zone_id}. slots: file: requestBody.file kind: requestBody.kind zone_id: path.zone_id - text: Upload {file} as schema {name} on zone {zone_id} with kind {kind} and validation {validation_enabled}. slots: file: requestBody.file name: requestBody.name zone_id: path.zone_id kind: requestBody.kind validation_enabled: requestBody.validation_enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/user_schemas/{schema_id}'].get update: x-apievangelist-phrasing: intent: Get one uploaded API schema effect: read questions: - How can I view the details of one schema I uploaded to API Shield? - Can I fetch a schema's metadata without its full source? instructions: - text: Show uploaded schema {schema_id} on zone {zone_id}. slots: schema_id: path.schema_id zone_id: path.zone_id - text: Get schema {schema_id} in zone {zone_id} without source ({omit_source}). slots: schema_id: path.schema_id zone_id: path.zone_id omit_source: query.omit_source method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/user_schemas/{schema_id}'].delete update: x-apievangelist-phrasing: intent: Delete an uploaded API schema effect: destructive questions: - How do I remove a schema I uploaded to API Shield? - Does deleting a schema stop validation for its endpoints? instructions: - text: Delete schema {schema_id} from zone {zone_id}. slots: schema_id: path.schema_id zone_id: path.zone_id - text: Remove uploaded API schema {schema_id} on zone {zone_id}. slots: schema_id: path.schema_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/user_schemas/{schema_id}'].patch update: x-apievangelist-phrasing: intent: Turn validation on or off for a schema effect: write questions: - How do I start enforcing an uploaded schema? - Can I pause validation for one schema without deleting it? instructions: - text: 'Enable validation for schema {schema_id} on zone {zone_id}: {validation_enabled}.' slots: schema_id: path.schema_id zone_id: path.zone_id validation_enabled: requestBody.validation_enabled - text: Set validation_enabled to {validation_enabled} for schema {schema_id} in zone {zone_id}. slots: validation_enabled: requestBody.validation_enabled schema_id: path.schema_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations'].get update: x-apievangelist-phrasing: intent: List operations defined in an uploaded schema effect: read questions: - Which endpoints does my uploaded schema describe? - Can I see which operations in a schema are not yet in Endpoint Management? instructions: - text: List the operations in schema {schema_id} on zone {zone_id}. slots: schema_id: path.schema_id zone_id: path.zone_id - text: Show operations from schema {schema_id} in zone {zone_id} with status {operation_status}. slots: schema_id: path.schema_id zone_id: path.zone_id operation_status: query.operation_status method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/argo/smart_routing'].get update: x-apievangelist-phrasing: intent: Check if Argo Smart Routing is on effect: read questions: - Is Argo Smart Routing enabled for my zone? - How can I see my zone's Argo Smart Routing setting? instructions: - text: Show the Argo Smart Routing setting for zone {zone_id}. slots: zone_id: path.zone_id - text: Check whether smart routing is on for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/argo/smart_routing'].patch update: x-apievangelist-phrasing: intent: Turn Argo Smart Routing on or off effect: write questions: - How do I enable Argo Smart Routing to route traffic over faster paths? - Can I switch off Argo Smart Routing for a zone? instructions: - text: Set Argo Smart Routing on zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value - text: Turn smart routing {value} for zone {zone_id}. slots: value: requestBody.value zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/argo/tiered_caching'].get update: x-apievangelist-phrasing: intent: Check if Tiered Caching is on effect: read questions: - Is Argo Tiered Caching enabled on my zone? - Where can I read the Tiered Caching setting? instructions: - text: Show the Tiered Caching setting for zone {zone_id}. slots: zone_id: path.zone_id - text: Check whether Argo Tiered Caching is enabled on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/argo/tiered_caching'].patch update: x-apievangelist-phrasing: intent: Turn Tiered Caching on or off effect: write questions: - How do I enable Tiered Caching to cut requests to my origin? - Can I disable Argo Tiered Caching for a zone? instructions: - text: Set Tiered Caching on zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value - text: Switch Argo Tiered Caching {value} for zone {zone_id}. slots: value: requestBody.value zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/bot_management'].get update: x-apievangelist-phrasing: intent: Get bot management config effect: read questions: - What bot protection settings are active on my zone? - Is Bot Fight Mode or Super Bot Fight Mode on for this domain? instructions: - text: Show the bot management configuration for zone {zone_id}. slots: zone_id: path.zone_id - text: Get the bot protection settings of zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/bot_management'].put update: x-apievangelist-phrasing: intent: Update bot management config effect: write questions: - How do I turn on Bot Fight Mode for my zone? - Can I change Super Bot Fight Mode or enterprise bot settings through the API? instructions: - text: Update the bot management configuration for zone {zone_id}. slots: zone_id: path.zone_id - text: Enable Bot Fight Mode on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/cache_reserve'].get update: x-apievangelist-phrasing: intent: Check Cache Reserve setting effect: read questions: - Is Cache Reserve storing my cacheable files in persistent storage? - What is the Cache Reserve setting for my zone? instructions: - text: Show the Cache Reserve setting for zone {zone_id}. slots: zone_id: path.zone_id - text: Check if Cache Reserve is on for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/cache_reserve'].patch update: x-apievangelist-phrasing: intent: Turn Cache Reserve on or off effect: write questions: - How do I extend cache lifetimes by enabling Cache Reserve? - Do I need a Cache Reserve subscription before turning it on? instructions: - text: Set Cache Reserve on zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value - text: Turn Cache Reserve {value} for zone {zone_id}. slots: value: requestBody.value zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/cache_reserve_clear'].get update: x-apievangelist-phrasing: intent: Check Cache Reserve Clear status effect: read questions: - Has my Cache Reserve Clear finished yet? - How do I see the progress of clearing Cache Reserve? instructions: - text: Show the Cache Reserve Clear status for zone {zone_id}. slots: zone_id: path.zone_id - text: Check whether clearing Cache Reserve is done on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/cache_reserve_clear'].post update: x-apievangelist-phrasing: intent: Start clearing Cache Reserve effect: destructive questions: - How do I wipe everything stored in Cache Reserve? - Must Cache Reserve be disabled before I clear it? instructions: - text: Start a Cache Reserve Clear on zone {zone_id}. slots: zone_id: path.zone_id - text: Empty the Cache Reserve for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/origin_post_quantum_encryption'].get update: x-apievangelist-phrasing: intent: Get origin post-quantum encryption setting effect: read questions: - Does Cloudflare use post-quantum key agreement when connecting to my origin? - Is origin PQ encryption set to preferred or supported for this zone? instructions: - text: Show the origin post-quantum encryption setting for zone {zone_id}. slots: zone_id: path.zone_id - text: Check PQ key agreement to origin on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/origin_post_quantum_encryption'].put update: x-apievangelist-phrasing: intent: Set origin post-quantum encryption effect: write questions: - How do I make Cloudflare prefer post-quantum encryption to my origin server? - Can I turn off post-quantum key agreement toward my origin? instructions: - text: Set origin post-quantum encryption on zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value - text: Change PQ encryption to origin for zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/regional_tiered_cache'].get update: x-apievangelist-phrasing: intent: Get Regional Tiered Cache setting effect: read questions: - Is Regional Tiered Cache checking a regional hub before my upper tier? - What is the Regional Tiered Cache setting on my zone? instructions: - text: Show the Regional Tiered Cache setting for zone {zone_id}. slots: zone_id: path.zone_id - text: Check if regional hub caching is on for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/regional_tiered_cache'].patch update: x-apievangelist-phrasing: intent: Turn Regional Tiered Cache on or off effect: write questions: - How do I add a regional hub layer to my tiered cache topology? - Can I disable Regional Tiered Cache on a zone? instructions: - text: Set Regional Tiered Cache on zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value - text: Turn regional hub caching {value} for zone {zone_id}. slots: value: requestBody.value zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/tiered_cache_smart_topology_enable'].get update: x-apievangelist-phrasing: intent: Get Smart Tiered Cache setting effect: read questions: - Is Smart Tiered Cache topology enabled for my zone? - Where can I read the Smart Tiered Cache setting? instructions: - text: Show the Smart Tiered Cache setting for zone {zone_id}. slots: zone_id: path.zone_id - text: Check smart topology for tiered cache on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/tiered_cache_smart_topology_enable'].delete update: x-apievangelist-phrasing: intent: Remove Smart Tiered Cache setting effect: destructive questions: - How do I remove the Smart Tiered Cache setting from my zone entirely? - What happens when I delete Smart Tiered Cache enablement? instructions: - text: Delete the Smart Tiered Cache setting on zone {zone_id}. slots: zone_id: path.zone_id - text: Remove smart topology tiered caching from zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/tiered_cache_smart_topology_enable'].patch update: x-apievangelist-phrasing: intent: Turn Smart Tiered Cache on or off effect: write questions: - How do I enable Smart Tiered Cache topology? - Can I switch Smart Tiered Cache off without deleting the setting? instructions: - text: Set Smart Tiered Cache on zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value - text: Turn smart tiered cache topology {value} for zone {zone_id}. slots: value: requestBody.value zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/variants'].get update: x-apievangelist-phrasing: intent: Get image variants cache setting effect: read questions: - Which image file extensions have cached variants on my zone? - How can I see my zone's variants setting for serving WebP or AVIF? instructions: - text: Show the cache variants setting for zone {zone_id}. slots: zone_id: path.zone_id - text: Get which image variants are cached on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/variants'].delete update: x-apievangelist-phrasing: intent: Delete image variants cache setting effect: destructive questions: - How do I stop caching image variants on my zone? - What happens when I remove the variants setting? instructions: - text: Delete the cache variants setting on zone {zone_id}. slots: zone_id: path.zone_id - text: Remove image variant caching from zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/cache/variants'].patch update: x-apievangelist-phrasing: intent: Change image variants cache setting effect: write questions: - How do I cache WebP variants of JPG images alongside the originals? - Can I choose which file extensions get cached variants? instructions: - text: Set the cache variants on zone {zone_id} to {value}. slots: zone_id: path.zone_id value: requestBody.value - text: Configure image variant caching for zone {zone_id} as {value}. slots: zone_id: path.zone_id value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/certificate_authorities/hostname_associations'].get update: x-apievangelist-phrasing: intent: List mTLS hostname associations effect: read questions: - Which hostnames require API Shield client certificates on my zone? - Can I see hostnames associated with a specific mTLS certificate? instructions: - text: List the client certificate hostname associations on zone {zone_id}. slots: zone_id: path.zone_id - text: Show hostnames tied to mTLS certificate {mtls_certificate_id} on zone {zone_id}. slots: mtls_certificate_id: query.mtls_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/certificate_authorities/hostname_associations'].put update: x-apievangelist-phrasing: intent: Replace mTLS hostname associations effect: write questions: - How do I choose which hostnames enforce client certificate mTLS? - Can I link hostnames to my own uploaded mTLS CA certificate? instructions: - text: Replace the mTLS hostname associations on zone {zone_id} with {hostnames}. slots: zone_id: path.zone_id hostnames: requestBody.hostnames - text: Enforce client certs from CA {mtls_certificate_id} on hostnames {hostnames} in API Shield for zone {zone_id}. slots: mtls_certificate_id: requestBody.mtls_certificate_id hostnames: requestBody.hostnames zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/client_certificates'].get update: x-apievangelist-phrasing: intent: List API Shield client certificates effect: read questions: - What mTLS client certificates have been issued for my zone? - Can I list only the client certificates that are revoked or pending? instructions: - text: List the API Shield client certificates on zone {zone_id}. slots: zone_id: path.zone_id - text: Show client certificates on zone {zone_id} with status {status}. slots: zone_id: path.zone_id status: query.status method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/client_certificates'].post update: x-apievangelist-phrasing: intent: Issue an API Shield client certificate effect: write questions: - How do I issue a client certificate for mTLS from a CSR? - How long can a new client certificate stay valid? instructions: - text: Issue a client certificate on zone {zone_id} from CSR {csr} valid for {validity_days} days. slots: zone_id: path.zone_id csr: requestBody.csr validity_days: requestBody.validity_days - text: Create an mTLS client cert for zone {zone_id} using {csr} for {validity_days} days. slots: zone_id: path.zone_id csr: requestBody.csr validity_days: requestBody.validity_days method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/client_certificates/{client_certificate_id}'].get update: x-apievangelist-phrasing: intent: Get one client certificate effect: read questions: - How can I see the status and expiry of a single client certificate? - What details does API Shield keep for one mTLS client cert? instructions: - text: Show client certificate {client_certificate_id} on zone {zone_id}. slots: client_certificate_id: path.client_certificate_id zone_id: path.zone_id - text: Get details of mTLS client cert {client_certificate_id} in zone {zone_id}. slots: client_certificate_id: path.client_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/client_certificates/{client_certificate_id}'].delete update: x-apievangelist-phrasing: intent: Revoke a client certificate effect: destructive questions: - How do I revoke a compromised mTLS client certificate? - What state does a client certificate go into when I revoke it? instructions: - text: Revoke client certificate {client_certificate_id} on zone {zone_id}. slots: client_certificate_id: path.client_certificate_id zone_id: path.zone_id - text: Put mTLS client cert {client_certificate_id} in zone {zone_id} into pending revocation. slots: client_certificate_id: path.client_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/client_certificates/{client_certificate_id}'].patch update: x-apievangelist-phrasing: intent: Reactivate a client certificate effect: write questions: - Can I undo a client certificate revocation that is still pending? - How do I reactivate an mTLS client cert before it is fully revoked? instructions: - text: Reactivate client certificate {client_certificate_id} on zone {zone_id}. slots: client_certificate_id: path.client_certificate_id zone_id: path.zone_id - text: Cancel the pending revocation of client cert {client_certificate_id} in zone {zone_id}. slots: client_certificate_id: path.client_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_certificates'].get update: x-apievangelist-phrasing: intent: List custom SSL certificates effect: read questions: - Which custom SSL certificates have I uploaded to my zone? - Can I filter uploaded certificates by status? instructions: - text: List the custom SSL certificates on zone {zone_id}. slots: zone_id: path.zone_id - text: Show custom certificates on zone {zone_id} with status {status}. slots: zone_id: path.zone_id status: query.status method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_certificates'].post update: x-apievangelist-phrasing: intent: Upload a custom SSL certificate effect: write questions: - How do I upload my own SSL certificate and private key to a zone? - Can I restrict where my custom certificate's key is used geographically? instructions: - text: Upload certificate {certificate} with key {private_key} to zone {zone_id}. slots: certificate: requestBody.certificate private_key: requestBody.private_key zone_id: path.zone_id - text: Add custom SSL cert {certificate} and key {private_key} to zone {zone_id} as type {type}. slots: certificate: requestBody.certificate private_key: requestBody.private_key zone_id: path.zone_id type: requestBody.type method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_certificates/{custom_certificate_id}'].get update: x-apievangelist-phrasing: intent: Get a custom SSL certificate effect: read questions: - How can I see the hosts and expiry date of one uploaded certificate? - What bundle method does a particular custom certificate use? instructions: - text: Show custom certificate {custom_certificate_id} on zone {zone_id}. slots: custom_certificate_id: path.custom_certificate_id zone_id: path.zone_id - text: Get the details of uploaded cert {custom_certificate_id} in zone {zone_id}. slots: custom_certificate_id: path.custom_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_certificates/{custom_certificate_id}'].delete update: x-apievangelist-phrasing: intent: Delete a custom SSL certificate effect: destructive questions: - How do I remove an uploaded SSL certificate from my zone? - What will serve TLS for my hostnames after I delete a custom certificate? instructions: - text: Delete custom certificate {custom_certificate_id} from zone {zone_id}. slots: custom_certificate_id: path.custom_certificate_id zone_id: path.zone_id - text: Remove uploaded SSL cert {custom_certificate_id} on zone {zone_id}. slots: custom_certificate_id: path.custom_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_certificates/{custom_certificate_id}'].patch update: x-apievangelist-phrasing: intent: Replace a custom certificate's key or PEM effect: write questions: - How do I renew an uploaded certificate with a new PEM and private key? - Does editing an SNI custom certificate change its ID? instructions: - text: Replace the PEM of custom certificate {custom_certificate_id} on zone {zone_id} with {certificate}. slots: custom_certificate_id: path.custom_certificate_id zone_id: path.zone_id certificate: requestBody.certificate - text: Upload new key {private_key} and cert {certificate} for {custom_certificate_id} in zone {zone_id}. slots: private_key: requestBody.private_key certificate: requestBody.certificate custom_certificate_id: path.custom_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_certificates/prioritize'].put update: x-apievangelist-phrasing: intent: Reorder custom SSL certificate priority effect: write questions: - How do I decide which of several custom certificates is served first? - Can I change the priority order of overlapping legacy certificates? instructions: - text: Reprioritize the custom certificates on zone {zone_id} as {certificates}. slots: zone_id: path.zone_id certificates: requestBody.certificates - text: Set the certificate order for zone {zone_id} to {certificates}. slots: zone_id: path.zone_id certificates: requestBody.certificates method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames'].get update: x-apievangelist-phrasing: intent: List custom hostnames for SaaS customers effect: read questions: - Which of my customers' vanity domains are set up as custom hostnames? - Can I search custom hostnames by name or filter by SSL status? instructions: - text: List the custom hostnames on zone {zone_id}. slots: zone_id: path.zone_id - text: Find custom hostname {hostname} on zone {zone_id}. slots: hostname: query.hostname zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames'].post update: x-apievangelist-phrasing: intent: Add a custom hostname with SSL effect: write questions: - How do I onboard a customer's own domain onto my SaaS zone? - Which validation methods can I use for a new custom hostname's certificate? instructions: - text: Add custom hostname {hostname} to zone {zone_id} with SSL {ssl}. slots: hostname: requestBody.hostname zone_id: path.zone_id ssl: requestBody.ssl - text: Onboard {hostname} on zone {zone_id} using SSL settings {ssl} and metadata {custom_metadata}. slots: hostname: requestBody.hostname zone_id: path.zone_id ssl: requestBody.ssl custom_metadata: requestBody.custom_metadata method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames/{custom_hostname_id}'].get update: x-apievangelist-phrasing: intent: Get one custom hostname effect: read questions: - How can I check whether a customer's custom hostname has finished validation? - What SSL status does a particular custom hostname have? instructions: - text: Show custom hostname {custom_hostname_id} on zone {zone_id}. slots: custom_hostname_id: path.custom_hostname_id zone_id: path.zone_id - text: Get the validation status of custom hostname {custom_hostname_id} in zone {zone_id}. slots: custom_hostname_id: path.custom_hostname_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames/{custom_hostname_id}'].delete update: x-apievangelist-phrasing: intent: Delete a custom hostname and its certificates effect: destructive questions: - How do I offboard a customer's vanity domain from my zone? - Are issued SSL certificates removed too when I delete a custom hostname? instructions: - text: Delete custom hostname {custom_hostname_id} from zone {zone_id}. slots: custom_hostname_id: path.custom_hostname_id zone_id: path.zone_id - text: Remove {custom_hostname_id} and its SSL certificates from zone {zone_id}. slots: custom_hostname_id: path.custom_hostname_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames/{custom_hostname_id}'].patch update: x-apievangelist-phrasing: intent: Edit a custom hostname's SSL or origin effect: write questions: - How do I point one custom hostname at a different origin server? - Can I retrigger domain control validation for a custom hostname? instructions: - text: Send custom hostname {custom_hostname_id} on zone {zone_id} to origin {custom_origin_server}. slots: custom_hostname_id: path.custom_hostname_id zone_id: path.zone_id custom_origin_server: requestBody.custom_origin_server - text: Update SSL settings of custom hostname {custom_hostname_id} in zone {zone_id} to {ssl}. slots: custom_hostname_id: path.custom_hostname_id zone_id: path.zone_id ssl: requestBody.ssl - text: Set custom metadata {custom_metadata} on custom hostname {custom_hostname_id} in zone {zone_id}. slots: custom_metadata: requestBody.custom_metadata custom_hostname_id: path.custom_hostname_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames/fallback_origin'].get update: x-apievangelist-phrasing: intent: Get the custom hostname fallback origin effect: read questions: - Where does traffic for my custom hostnames go when no custom origin is set? - What is the status of my fallback origin? instructions: - text: Show the fallback origin for custom hostnames on zone {zone_id}. slots: zone_id: path.zone_id - text: Get the default origin for SaaS hostnames in zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames/fallback_origin'].put update: x-apievangelist-phrasing: intent: Set the custom hostname fallback origin effect: write questions: - How do I choose the default origin my customers' custom hostnames route to? - Can I change the fallback origin to a different hostname? instructions: - text: Set the fallback origin for custom hostnames on zone {zone_id} to {origin}. slots: zone_id: path.zone_id origin: requestBody.origin - text: Route SaaS custom hostnames in zone {zone_id} to fallback {origin}. slots: zone_id: path.zone_id origin: requestBody.origin method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_hostnames/fallback_origin'].delete update: x-apievangelist-phrasing: intent: Remove the custom hostname fallback origin effect: destructive questions: - How do I clear the fallback origin for custom hostnames? - What happens to custom hostnames without an origin once I delete the fallback? instructions: - text: Delete the fallback origin for custom hostnames on zone {zone_id}. slots: zone_id: path.zone_id - text: Remove the SaaS default origin from zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_ns'].get update: x-apievangelist-phrasing: intent: Get a zone's account custom nameserver usage effect: read questions: - Is this zone using my account's custom nameservers? - Which custom nameserver set is assigned to a zone? instructions: - text: Show account custom nameserver metadata for zone {zone_id}. slots: zone_id: path.zone_id - text: Check which custom NS set zone {zone_id} uses. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/custom_ns'].put update: x-apievangelist-phrasing: intent: Set a zone to use account custom nameservers effect: write questions: - How do I switch one zone onto my account-level custom nameservers? - Can I choose which nameserver set a zone uses? instructions: - text: 'Enable account custom nameservers on zone {zone_id}: {enabled}.' slots: zone_id: path.zone_id enabled: requestBody.enabled - text: Assign custom nameserver set {ns_set} to zone {zone_id}. slots: ns_set: requestBody.ns_set zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dcv_delegation/uuid'].get update: x-apievangelist-phrasing: intent: Get the DCV Delegation identifier effect: read questions: - What CNAME target do I need to delegate domain control validation to Cloudflare? - Where do I find the unique ID used for DCV Delegation? instructions: - text: Get the DCV Delegation UUID for zone {zone_id}. slots: zone_id: path.zone_id - text: Show the DCV delegation CNAME identifier on zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records'].get update: x-apievangelist-phrasing: intent: List and search DNS records effect: read questions: - How do I see all the DNS records for my domain? - Can I find only the proxied A records, or records with a certain tag or comment? instructions: - text: List the DNS records in zone {zone_id}. slots: zone_id: path.zone_id - text: Show {type} records named {name} in zone {zone_id}. slots: type: query.type name: query.name zone_id: path.zone_id - text: Search DNS records in zone {zone_id} for {search}. slots: zone_id: path.zone_id search: query.search method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records'].post update: x-apievangelist-phrasing: intent: Create a DNS record effect: write questions: - How do I add a new A or CNAME record to my zone? - Why can't I create an A record on a name that already has a CNAME? instructions: - text: Create a new DNS record in zone {zone_id}. slots: zone_id: path.zone_id - text: Add a DNS record to zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].get update: x-apievangelist-phrasing: intent: Get one DNS record effect: read questions: - How can I look up the content and TTL of a single DNS record? - Is a specific DNS record proxied? instructions: - text: Show DNS record {dns_record_id} in zone {zone_id}. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id - text: Get the details of record {dns_record_id} on zone {zone_id}. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].put update: x-apievangelist-phrasing: intent: Overwrite a DNS record effect: write questions: - How do I replace every field of an existing DNS record in one go? - Does overwriting a record reset fields I leave out? instructions: - text: Overwrite DNS record {dns_record_id} in zone {zone_id}. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id - text: Fully replace record {dns_record_id} on zone {zone_id} with new values. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].delete update: x-apievangelist-phrasing: intent: Delete a DNS record effect: destructive questions: - How do I remove a DNS record from my zone? - Can a deleted DNS record be recovered? instructions: - text: Delete DNS record {dns_record_id} from zone {zone_id}. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id - text: Remove record {dns_record_id} on zone {zone_id}. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records/{dns_record_id}'].patch update: x-apievangelist-phrasing: intent: Partially update a DNS record effect: write questions: - Can I change just the IP address of a DNS record without resending everything? - How do I toggle proxying on one existing record? instructions: - text: Patch DNS record {dns_record_id} in zone {zone_id}. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id - text: Change only some fields of record {dns_record_id} on zone {zone_id}. slots: dns_record_id: path.dns_record_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records/export'].get update: x-apievangelist-phrasing: intent: Export DNS records as a BIND file effect: read questions: - How do I back up my zone's DNS records as a zone file? - Can I download my records in BIND format? instructions: - text: Export the DNS records of zone {zone_id} as BIND. slots: zone_id: path.zone_id - text: Download a zone file for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records/import'].post update: x-apievangelist-phrasing: intent: Import DNS records from a BIND file effect: write questions: - How do I bulk load DNS records from a zone file? - Can imported records be set to proxied automatically? instructions: - text: Import BIND file {file} into zone {zone_id}. slots: file: requestBody.file zone_id: path.zone_id - text: Upload zone file {file} to zone {zone_id} with proxied {proxied}. slots: file: requestBody.file zone_id: path.zone_id proxied: requestBody.proxied method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dns_records/scan'].post update: x-apievangelist-phrasing: intent: Scan for and add common DNS records effect: write questions: - Can Cloudflare discover my existing DNS records before I switch nameservers? - How do I auto-populate common records for a new domain? instructions: - text: Scan for common DNS records on zone {zone_id} and add them. slots: zone_id: path.zone_id - text: Auto-detect existing records for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dnssec'].get update: x-apievangelist-phrasing: intent: Get DNSSEC status effect: read questions: - Is DNSSEC active on my domain, and what DS record do I give my registrar? - Where can I see my zone's DNSSEC configuration? instructions: - text: Show DNSSEC details for zone {zone_id}. slots: zone_id: path.zone_id - text: Get the DS record and DNSSEC status of zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dnssec'].delete update: x-apievangelist-phrasing: intent: Delete DNSSEC records effect: destructive questions: - How do I remove DNSSEC from my zone completely? - What should I do at my registrar before deleting DNSSEC? instructions: - text: Delete DNSSEC on zone {zone_id}. slots: zone_id: path.zone_id - text: Remove DNSSEC records from zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/dnssec'].patch update: x-apievangelist-phrasing: intent: Turn DNSSEC on or off effect: write questions: - How do I enable DNSSEC for my domain? - Can I use multi-signer or presigned DNSSEC? instructions: - text: Set DNSSEC status on zone {zone_id} to {status}. slots: zone_id: path.zone_id status: requestBody.status - text: 'Enable multi-signer DNSSEC on zone {zone_id}: {dnssec_multi_signer}.' slots: zone_id: path.zone_id dnssec_multi_signer: requestBody.dnssec_multi_signer method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/access_rules/rules'].get update: x-apievangelist-phrasing: intent: List IP Access rules for a zone effect: read questions: - Which IPs, ranges or countries am I blocking or allowing on this zone? - Can I filter IP Access rules by mode? instructions: - text: List the IP Access rules on zone {zone_id}. slots: zone_id: path.zone_id - text: Show IP Access rules on zone {zone_id} matching {filters}. slots: zone_id: path.zone_id filters: query.filters method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/access_rules/rules'].post update: x-apievangelist-phrasing: intent: Block or allow an IP on a zone effect: write questions: - How do I block an IP address or country on one domain? - Can I challenge instead of block traffic from an IP range? instructions: - text: Create an IP Access rule on zone {zone_id} to {mode} {configuration} with note {notes}. slots: zone_id: path.zone_id mode: requestBody.mode configuration: requestBody.configuration notes: requestBody.notes - text: Block {configuration} on zone {zone_id} using mode {mode}, noting {notes}. slots: configuration: requestBody.configuration zone_id: path.zone_id mode: requestBody.mode notes: requestBody.notes method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/access_rules/rules/{identifier}'].delete update: x-apievangelist-phrasing: intent: Delete an IP Access rule effect: destructive questions: - How do I unblock an IP by removing its access rule? - Can deleting a rule also remove similar rules in my other zones? instructions: - text: Delete IP Access rule {identifier} from zone {zone_id}. slots: identifier: path.identifier zone_id: path.zone_id - text: Remove rule {identifier} on zone {zone_id} and cascade {cascade}. slots: identifier: path.identifier zone_id: path.zone_id cascade: requestBody.cascade method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/access_rules/rules/{identifier}'].patch update: x-apievangelist-phrasing: intent: Change an IP Access rule's action or note effect: write questions: - Can I switch an existing IP rule from block to challenge? - Which fields of an IP Access rule can I update? instructions: - text: Change IP Access rule {identifier} on zone {zone_id} to mode {mode}. slots: identifier: path.identifier zone_id: path.zone_id mode: requestBody.mode - text: Update the notes on rule {identifier} in zone {zone_id} to {notes}. slots: identifier: path.identifier zone_id: path.zone_id notes: requestBody.notes method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/waf/packages/{package_id}/groups'].get update: x-apievangelist-phrasing: intent: List WAF rule groups in a package effect: read questions: - Which rule groups are in a legacy WAF managed rules package? - Can I list only the WAF rule groups that are turned on? instructions: - text: List WAF rule groups in package {package_id} on zone {zone_id}. slots: package_id: path.package_id zone_id: path.zone_id - text: Show rule groups in package {package_id} of zone {zone_id} with mode {mode}. slots: package_id: path.package_id zone_id: path.zone_id mode: query.mode method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}'].get update: x-apievangelist-phrasing: intent: Get a WAF rule group effect: read questions: - How can I see whether one legacy WAF rule group is on or off? - How many rules are in a particular WAF rule group? instructions: - text: Show WAF rule group {group_id} in package {package_id} on zone {zone_id}. slots: group_id: path.group_id package_id: path.package_id zone_id: path.zone_id - text: Get details of rule group {group_id}, package {package_id}, zone {zone_id}. slots: group_id: path.group_id package_id: path.package_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}'].patch update: x-apievangelist-phrasing: intent: Turn a WAF rule group on or off effect: write questions: - How do I disable a whole group of legacy WAF managed rules? - Can I switch a WAF rule group back on? instructions: - text: Set WAF rule group {group_id} in package {package_id} on zone {zone_id} to {mode}. slots: group_id: path.group_id package_id: path.package_id zone_id: path.zone_id mode: requestBody.mode - text: Turn rule group {group_id} of package {package_id}, zone {zone_id}, {mode}. slots: group_id: path.group_id package_id: path.package_id zone_id: path.zone_id mode: requestBody.mode method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/waf/packages/{package_id}/rules'].get update: x-apievangelist-phrasing: intent: List WAF rules in a package effect: read questions: - Which individual rules are in a legacy WAF package? - Can I list WAF rules belonging to a single rule group? instructions: - text: List WAF rules in package {package_id} on zone {zone_id}. slots: package_id: path.package_id zone_id: path.zone_id - text: Show WAF rules in group {group_id} of package {package_id} on zone {zone_id}. slots: group_id: query.group_id package_id: path.package_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}'].get update: x-apievangelist-phrasing: intent: Get a single WAF rule effect: read questions: - How do I see the action and description of one legacy WAF rule? - What mode is a specific managed WAF rule set to? instructions: - text: Look up the single managed WAF rule {rule_id} (package {package_id}, zone {zone_id}). slots: rule_id: path.rule_id package_id: path.package_id zone_id: path.zone_id - text: Fetch the description and action of WAF rule {rule_id} in package {package_id} on zone {zone_id}. slots: rule_id: path.rule_id package_id: path.package_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}'].patch update: x-apievangelist-phrasing: intent: Change a single WAF rule's action effect: write questions: - How do I disable one noisy legacy WAF rule causing false positives? - Can I change anything other than the mode on a WAF rule? instructions: - text: Switch individual WAF rule {rule_id} of package {package_id} on zone {zone_id} to action {mode}. slots: rule_id: path.rule_id package_id: path.package_id zone_id: path.zone_id mode: requestBody.mode - text: Change the action of rule {rule_id}, package {package_id}, zone {zone_id}, to {mode}. slots: rule_id: path.rule_id package_id: path.package_id zone_id: path.zone_id mode: requestBody.mode method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/hold'].get update: x-apievangelist-phrasing: intent: Check a zone hold effect: read questions: - Is my zone under a hold that stops others from adding this hostname? - Does the zone hold also cover subdomains? instructions: - text: Show the zone hold status for zone {zone_id}. slots: zone_id: path.zone_id - text: Check whether zone {zone_id} is held. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/hold'].post update: x-apievangelist-phrasing: intent: Place a zone hold effect: write questions: - How do I prevent anyone else from adding my domain as a zone? - Can a zone hold block subdomains too? instructions: - text: Place a zone hold on zone {zone_id}. slots: zone_id: path.zone_id - text: Hold zone {zone_id} including subdomains {include_subdomains}. slots: zone_id: path.zone_id include_subdomains: query.include_subdomains method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/hold'].delete update: x-apievangelist-phrasing: intent: Release a zone hold effect: destructive questions: - How do I lift a zone hold so my hostname can be added elsewhere? - Can I release a zone hold only temporarily? instructions: - text: Remove the zone hold on zone {zone_id}. slots: zone_id: path.zone_id - text: Release the hold on zone {zone_id} until {hold_after}. slots: zone_id: path.zone_id hold_after: query.hold_after method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/hostnames/settings/{setting_id}'].get update: x-apievangelist-phrasing: intent: List a TLS setting across hostnames effect: read questions: - Which hostnames in my zone have a custom minimum TLS version? - Can I see per-hostname values for a TLS setting like ciphers or HTTP/2? instructions: - text: List hostname values for TLS setting {setting_id} on zone {zone_id}. slots: setting_id: path.setting_id zone_id: path.zone_id - text: Show every hostname's {setting_id} setting in zone {zone_id}. slots: setting_id: path.setting_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}'].put update: x-apievangelist-phrasing: intent: Set a TLS setting for one hostname effect: write questions: - How do I require TLS 1.2 or higher on just one hostname? - Can I set a different cipher list for a single hostname? instructions: - text: Set TLS setting {setting_id} for {hostname} on zone {zone_id} to {value}. slots: setting_id: path.setting_id hostname: path.hostname zone_id: path.zone_id value: requestBody.value - text: Change {hostname}'s {setting_id} in zone {zone_id} to {value}. slots: hostname: path.hostname setting_id: path.setting_id zone_id: path.zone_id value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}'].delete update: x-apievangelist-phrasing: intent: Remove a hostname's TLS setting override effect: destructive questions: - How do I drop a per-hostname TLS override so the zone default applies? - What value does a hostname use after I delete its TLS setting? instructions: - text: Delete TLS setting {setting_id} for {hostname} on zone {zone_id}. slots: setting_id: path.setting_id hostname: path.hostname zone_id: path.zone_id - text: Clear {hostname}'s {setting_id} override in zone {zone_id}. slots: hostname: path.hostname setting_id: path.setting_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/keyless_certificates'].get update: x-apievangelist-phrasing: intent: List Keyless SSL configurations effect: read questions: - Which Keyless SSL servers are set up for my zone? - Can I see every configuration that keeps my private keys on my own servers? instructions: - text: List the Keyless SSL configurations on zone {zone_id}. slots: zone_id: path.zone_id - text: Show all keyless certificates in zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/keyless_certificates'].post update: x-apievangelist-phrasing: intent: Create a Keyless SSL configuration effect: write questions: - How do I use TLS without handing my private key to Cloudflare? - Can a keyless server be reached through a Cloudflare Tunnel? instructions: - text: Create Keyless SSL for zone {zone_id} with cert {certificate} on key server {host}:{port}. slots: zone_id: path.zone_id certificate: requestBody.certificate host: requestBody.host port: requestBody.port - text: Set up keyless certificate {name} on zone {zone_id} using {certificate}, host {host}, port {port}. slots: name: requestBody.name zone_id: path.zone_id certificate: requestBody.certificate host: requestBody.host port: requestBody.port method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/keyless_certificates/{keyless_certificate_id}'].get update: x-apievangelist-phrasing: intent: Get a Keyless SSL configuration effect: read questions: - How can I see the key server host and port for one Keyless SSL setup? - Is a particular Keyless SSL configuration active? instructions: - text: Show Keyless SSL configuration {keyless_certificate_id} on zone {zone_id}. slots: keyless_certificate_id: path.keyless_certificate_id zone_id: path.zone_id - text: Get keyless certificate {keyless_certificate_id} in zone {zone_id}. slots: keyless_certificate_id: path.keyless_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/keyless_certificates/{keyless_certificate_id}'].delete update: x-apievangelist-phrasing: intent: Delete a Keyless SSL configuration effect: destructive questions: - How do I remove a Keyless SSL configuration from my zone? - What happens to TLS on my hostnames when I delete a keyless cert? instructions: - text: Delete Keyless SSL configuration {keyless_certificate_id} from zone {zone_id}. slots: keyless_certificate_id: path.keyless_certificate_id zone_id: path.zone_id - text: Remove keyless certificate {keyless_certificate_id} on zone {zone_id}. slots: keyless_certificate_id: path.keyless_certificate_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/keyless_certificates/{keyless_certificate_id}'].patch update: x-apievangelist-phrasing: intent: Edit a Keyless SSL configuration effect: write questions: - How do I move my Keyless SSL key server to a new host or port? - Can I disable a Keyless SSL configuration without deleting it? instructions: - text: Point Keyless SSL {keyless_certificate_id} on zone {zone_id} to {host}:{port}. slots: keyless_certificate_id: path.keyless_certificate_id zone_id: path.zone_id host: requestBody.host port: requestBody.port - text: Set keyless cert {keyless_certificate_id} in zone {zone_id} enabled to {enabled}. slots: keyless_certificate_id: path.keyless_certificate_id zone_id: path.zone_id enabled: requestBody.enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/load_balancers'].get update: x-apievangelist-phrasing: intent: List load balancers on a zone effect: read questions: - What load balancers are configured for my zone? - Can I see all my zone's load balancers and their pools? instructions: - text: List the load balancers on zone {zone_id}. slots: zone_id: path.zone_id - text: Show every load balancer in zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/load_balancers'].post update: x-apievangelist-phrasing: intent: Create a load balancer effect: write questions: - How do I spread traffic for a hostname across several origin pools? - Can a new load balancer steer traffic by region or country? instructions: - text: Create load balancer {name} on zone {zone_id} with pools {default_pools} and fallback {fallback_pool}. slots: name: requestBody.name zone_id: path.zone_id default_pools: requestBody.default_pools fallback_pool: requestBody.fallback_pool - text: Add a load balancer {name} to zone {zone_id} using steering policy {steering_policy}, pools {default_pools}, fallback {fallback_pool}. slots: name: requestBody.name zone_id: path.zone_id steering_policy: requestBody.steering_policy default_pools: requestBody.default_pools fallback_pool: requestBody.fallback_pool method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/load_balancers/{load_balancer_id}'].get update: x-apievangelist-phrasing: intent: Get one load balancer effect: read questions: - How can I view the pools and steering policy of one load balancer? - Is session affinity turned on for this load balancer? instructions: - text: Show load balancer {load_balancer_id} on zone {zone_id}. slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id - text: Get the config of load balancer {load_balancer_id} in zone {zone_id}. slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/load_balancers/{load_balancer_id}'].put update: x-apievangelist-phrasing: intent: Replace a load balancer's configuration effect: write questions: - How do I fully replace an existing load balancer's configuration? - Must I resend the name and pools when doing a full load balancer update? instructions: - text: 'Replace load balancer {load_balancer_id} on zone {zone_id}: name {name}, pools {default_pools}, fallback {fallback_pool}.' slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id name: requestBody.name default_pools: requestBody.default_pools fallback_pool: requestBody.fallback_pool - text: Overwrite load balancer {load_balancer_id} in zone {zone_id} with fallback pool {fallback_pool} and default pools {default_pools}. slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id fallback_pool: requestBody.fallback_pool default_pools: requestBody.default_pools method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/load_balancers/{load_balancer_id}'].delete update: x-apievangelist-phrasing: intent: Delete a load balancer effect: destructive questions: - How do I remove a load balancer from my zone? - What happens to traffic when I delete a load balancer? instructions: - text: Delete load balancer {load_balancer_id} from zone {zone_id}. slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id - text: Remove load balancer {load_balancer_id} on zone {zone_id}. slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/load_balancers/{load_balancer_id}'].patch update: x-apievangelist-phrasing: intent: Change some load balancer settings effect: write questions: - Can I disable a load balancer without resending its whole configuration? - How do I change just the steering policy of a load balancer? instructions: - text: Patch load balancer {load_balancer_id} on zone {zone_id} to enabled {enabled}. slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id enabled: requestBody.enabled - text: Change only the steering policy of {load_balancer_id} in zone {zone_id} to {steering_policy}. slots: load_balancer_id: path.load_balancer_id zone_id: path.zone_id steering_policy: requestBody.steering_policy method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/datasets/{dataset_id}/fields'].get update: x-apievangelist-phrasing: intent: List the log fields in a Logpush dataset effect: read questions: - Which fields can I include when pushing HTTP request logs? - What does each field in a Logpush dataset mean? instructions: - text: List the fields available in dataset {dataset_id} for zone {zone_id}. slots: dataset_id: path.dataset_id zone_id: path.zone_id - text: Show the Logpush field names and descriptions of {dataset_id} on zone {zone_id}. slots: dataset_id: path.dataset_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/datasets/{dataset_id}/jobs'].get update: x-apievangelist-phrasing: intent: List Logpush jobs for one dataset effect: read questions: - Which Logpush jobs are shipping a particular dataset for my zone? - Can I see only the jobs pushing firewall events? instructions: - text: List Logpush jobs for dataset {dataset_id} on zone {zone_id}. slots: dataset_id: path.dataset_id zone_id: path.zone_id - text: Show jobs exporting {dataset_id} in zone {zone_id}. slots: dataset_id: path.dataset_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/edge'].get update: x-apievangelist-phrasing: intent: List Instant Logs jobs effect: read questions: - What Instant Logs sessions are running on my zone? - Can I see my zone's live-tail log jobs? instructions: - text: List the Instant Logs jobs on zone {zone_id}. slots: zone_id: path.zone_id - text: Show live log streaming jobs in zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/edge'].post update: x-apievangelist-phrasing: intent: Start an Instant Logs job effect: write questions: - How do I stream live request logs from my zone? - Can I sample or filter an Instant Logs stream? instructions: - text: Start an Instant Logs job on zone {zone_id} with fields {fields}. slots: zone_id: path.zone_id fields: requestBody.fields - text: Create a live log stream for zone {zone_id} filtered by {filter} at sample rate {sample}. slots: zone_id: path.zone_id filter: requestBody.filter sample: requestBody.sample method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/jobs'].get update: x-apievangelist-phrasing: intent: List all Logpush jobs on a zone effect: read questions: - Where are my zone's logs being pushed right now? - Can I see every Logpush job regardless of dataset? instructions: - text: List all Logpush jobs on zone {zone_id}. slots: zone_id: path.zone_id - text: Show every log push destination for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/jobs'].post update: x-apievangelist-phrasing: intent: Create a Logpush job effect: write questions: - How do I send my zone's HTTP request logs to a storage bucket? - Do I need an ownership challenge to push logs to a new destination? instructions: - text: Create a Logpush job on zone {zone_id} sending to {destination_conf}. slots: zone_id: path.zone_id destination_conf: requestBody.destination_conf - text: Push dataset {dataset} from zone {zone_id} to {destination_conf} as job {name}. slots: dataset: requestBody.dataset zone_id: path.zone_id destination_conf: requestBody.destination_conf name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/jobs/{job_id}'].get update: x-apievangelist-phrasing: intent: Get one Logpush job effect: read questions: - How can I check the destination and status of a single Logpush job? - When did a particular Logpush job last succeed or fail? instructions: - text: Show Logpush job {job_id} on zone {zone_id}. slots: job_id: path.job_id zone_id: path.zone_id - text: Get details of log push job {job_id} in zone {zone_id}. slots: job_id: path.job_id zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/jobs/{job_id}'].put update: x-apievangelist-phrasing: intent: Update a Logpush job effect: write questions: - How do I change where an existing Logpush job sends logs? - Can I pause a Logpush job without deleting it? instructions: - text: Change the destination of Logpush job {job_id} on zone {zone_id} to {destination_conf}. slots: job_id: path.job_id zone_id: path.zone_id destination_conf: requestBody.destination_conf - text: Set Logpush job {job_id} in zone {zone_id} enabled to {enabled}. slots: job_id: path.job_id zone_id: path.zone_id enabled: requestBody.enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/jobs/{job_id}'].delete update: x-apievangelist-phrasing: intent: Delete a zone Logpush job effect: destructive questions: - Can I stop and remove a Logpush job that ships my zone's logs somewhere? - What happens to log delivery when I delete a zone Logpush job? instructions: - text: Delete Logpush job {job} on zone {zone}. slots: job: path.job_id zone: path.zone_id - text: Remove the log push job {job} from my zone {zone} so it stops sending logs. slots: job: path.job_id zone: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/ownership'].post update: x-apievangelist-phrasing: intent: Request a Logpush destination ownership challenge effect: write questions: - How do I prove I own the storage bucket I want to push zone logs to? - Where does Cloudflare send the ownership challenge token for a Logpush destination? instructions: - text: Send a new ownership challenge to Logpush destination {destination} for zone {zone}. slots: destination: requestBody.destination_conf zone: path.zone_id - text: Request an ownership challenge file for my log destination {destination}. slots: destination: requestBody.destination_conf method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/ownership/validate'].post update: x-apievangelist-phrasing: intent: Validate a Logpush ownership challenge effect: read questions: - Is the ownership challenge token I received for my log destination valid? - Can I confirm the challenge I found in my bucket before creating a Logpush job? instructions: - text: Validate ownership challenge {challenge} for destination {destination} on zone {zone}. slots: challenge: requestBody.ownership_challenge destination: requestBody.destination_conf zone: path.zone_id - text: Check that the challenge token {challenge} proves I own {destination}. slots: challenge: requestBody.ownership_challenge destination: requestBody.destination_conf method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/validate/destination/exists'].post update: x-apievangelist-phrasing: intent: Check if a Logpush job already uses a destination effect: read questions: - Is there already a zone Logpush job writing to this destination? - Can I find out whether a log destination is taken before I create another job for it? instructions: - text: Check whether any Logpush job on zone {zone} already sends to {destination}. slots: zone: path.zone_id destination: requestBody.destination_conf - text: Tell me if destination {destination} is already in use by a log push job. slots: destination: requestBody.destination_conf method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/logpush/validate/origin'].post update: x-apievangelist-phrasing: intent: Validate Logpush field and filter options effect: read questions: - Are my logpull_options (fields, timestamps, sampling) valid for a zone Logpush job? - What does Cloudflare say about the log options string I plan to use before I save the job? instructions: - text: Validate the log options {options} for a Logpush job on zone {zone}. slots: options: requestBody.logpull_options zone: path.zone_id - text: Check that the logpull options string {options} is accepted. slots: options: requestBody.logpull_options method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/managed_headers'].get update: x-apievangelist-phrasing: intent: List Managed Transforms and their status effect: read questions: - Which Managed Transforms are available for my zone and which are switched on? - Is the add-visitor-location-headers transform currently enabled? instructions: - text: List all Managed Transforms on zone {zone} with their enabled state. slots: zone: path.zone_id - text: Show me which managed request and response header transforms are active. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/managed_headers'].patch update: x-apievangelist-phrasing: intent: Turn Managed Transforms on or off effect: write questions: - Can I enable the managed transform that removes the X-Powered-By response header? - How do I switch several managed request header transforms on at once? instructions: - text: On zone {zone}, set managed request headers to {request_headers} and managed response headers to {response_headers}. slots: zone: path.zone_id request_headers: requestBody.managed_request_headers response_headers: requestBody.managed_response_headers - text: Enable the managed transforms {request_headers} for incoming requests on zone {zone}. slots: request_headers: requestBody.managed_request_headers zone: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth'].get update: x-apievangelist-phrasing: intent: List zone-level origin pull client certificates effect: read questions: - Which client certificates have I uploaded for zone-wide authenticated origin pulls? - What zone-level certificates does the edge present to my origin server? instructions: - text: List the zone-level authenticated origin pull certificates on zone {zone}. slots: zone: path.zone_id - text: Show every zone-wide client certificate used for edge-to-origin authentication. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth'].post update: x-apievangelist-phrasing: intent: Upload a zone-level origin pull certificate effect: write questions: - Can I use my own certificate instead of the shared one for edge-to-origin communication? - How do I upload a custom client certificate and key for authenticated origin pulls across the whole zone? instructions: - text: Upload certificate {certificate} with private key {private_key} for zone-level authenticated origin pulls on zone {zone}. slots: certificate: requestBody.certificate private_key: requestBody.private_key zone: path.zone_id - text: Replace the shared origin pull certificate on zone {zone} with my own cert {certificate} and key {private_key}. slots: zone: path.zone_id certificate: requestBody.certificate private_key: requestBody.private_key method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/{certificate_id}'].get update: x-apievangelist-phrasing: intent: Get a zone-level origin pull certificate effect: read questions: - When does my zone-level authenticated origin pull certificate expire? - What is the status of one zone-wide origin pull certificate I uploaded? instructions: - text: Get details of zone-level origin pull certificate {certificate} on zone {zone}. slots: certificate: path.certificate_id zone: path.zone_id - text: Show the issuer and expiry for zone-wide client certificate {certificate}. slots: certificate: path.certificate_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/{certificate_id}'].delete update: x-apievangelist-phrasing: intent: Delete a zone-level origin pull certificate effect: destructive questions: - Can I remove a zone-wide authenticated origin pull certificate I no longer use? - What do I call to delete an old zone-level client certificate for origin pulls? instructions: - text: Delete zone-level origin pull certificate {certificate} from zone {zone}. slots: certificate: path.certificate_id zone: path.zone_id - text: Remove the zone-wide client certificate {certificate} used for authenticated origin pulls. slots: certificate: path.certificate_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/hostnames'].put update: x-apievangelist-phrasing: intent: Enable or disable per-hostname origin pull auth effect: write questions: - How do I attach a client certificate to a specific hostname for authenticated origin pulls? - Can I disable client certificate authentication for one hostname without affecting the rest of the zone? instructions: - text: Apply hostname-to-certificate associations {config} on zone {zone}. slots: config: requestBody.config zone: path.zone_id - text: Enable, disable or invalidate per-hostname origin pull settings using {config}. slots: config: requestBody.config method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}'].get update: x-apievangelist-phrasing: intent: Get a hostname's origin pull auth status effect: read questions: - Is authenticated origin pull enabled for this particular hostname? - Which client certificate is associated with a hostname for origin authentication? instructions: - text: Get the client authentication status for hostname {hostname} on zone {zone}. slots: hostname: path.hostname zone: path.zone_id - text: Check whether {hostname} presents a client certificate to my origin. slots: hostname: path.hostname method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates'].get update: x-apievangelist-phrasing: intent: List per-hostname origin pull certificates effect: read questions: - What hostname client certificates have I uploaded for per-hostname origin pulls? - How many of my 10 per-zone hostname certificates are already used? instructions: - text: List the hostname client certificates on zone {zone}. slots: zone: path.zone_id - text: Show all per-hostname authenticated origin pull certificates I have uploaded. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates'].post update: x-apievangelist-phrasing: intent: Upload a hostname client certificate effect: write questions: - How do I upload a certificate for client authentication on a single hostname? - Is there a limit on how many hostname client certificates a zone can hold? instructions: - text: Upload hostname client certificate {certificate} with key {private_key} to zone {zone}. slots: certificate: requestBody.certificate private_key: requestBody.private_key zone: path.zone_id - text: Add a per-hostname origin pull certificate {certificate} and its private key {private_key}. slots: certificate: requestBody.certificate private_key: requestBody.private_key method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}'].get update: x-apievangelist-phrasing: intent: Get a hostname client certificate effect: read questions: - What are the details of a hostname client certificate I uploaded for origin pulls? - Has my per-hostname client certificate finished deploying? instructions: - text: Get hostname client certificate {certificate} on zone {zone}. slots: certificate: path.certificate_id zone: path.zone_id - text: Show status and expiry of per-hostname certificate {certificate}. slots: certificate: path.certificate_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}'].delete update: x-apievangelist-phrasing: intent: Delete a hostname client certificate effect: destructive questions: - Can I delete a per-hostname client certificate to free up one of my slots? - What removes a hostname-level authenticated origin pull certificate? instructions: - text: Delete hostname client certificate {certificate} from zone {zone}. slots: certificate: path.certificate_id zone: path.zone_id - text: Remove per-hostname origin pull certificate {certificate}. slots: certificate: path.certificate_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/settings'].get update: x-apievangelist-phrasing: intent: Check if zone-level origin pulls are enabled effect: read questions: - Is zone-level authenticated origin pull turned on for my site? - Does authenticated origin pull default to off for a zone? instructions: - text: Check whether zone-level authenticated origin pulls are enabled on zone {zone}. slots: zone: path.zone_id - text: Tell me if my zone currently authenticates edge-to-origin pulls. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/origin_tls_client_auth/settings'].put update: x-apievangelist-phrasing: intent: Turn zone-level origin pulls on or off effect: write questions: - How do I switch on authenticated origin pulls for my whole zone? - Should the origin be configured before or after I enable zone-level origin pulls? instructions: - text: Set zone-level authenticated origin pulls to {enabled} on zone {zone}. slots: enabled: requestBody.enabled zone: path.zone_id - text: Disable authenticated origin pulls across zone {zone}. slots: zone: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield'].get update: x-apievangelist-phrasing: intent: Get Page Shield settings effect: read questions: - Is Page Shield enabled on my zone? - Does Page Shield use the reporting endpoint or the connection URL path right now? instructions: - text: Get the Page Shield settings for zone {zone}. slots: zone: path.zone_id - text: Show whether Page Shield script monitoring is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield'].put update: x-apievangelist-phrasing: intent: Update Page Shield settings effect: write questions: - How do I turn on Page Shield for my site? - Can I make Page Shield report to the Cloudflare reporting endpoint instead of my own? instructions: - text: Set Page Shield enabled to {enabled} on zone {zone}. slots: enabled: requestBody.enabled zone: path.zone_id - text: 'Update Page Shield on zone {zone} to use the Cloudflare reporting endpoint: {use_reporting}.' slots: zone: path.zone_id use_reporting: requestBody.use_cloudflare_reporting_endpoint method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/connections'].get update: x-apievangelist-phrasing: intent: List connections detected by Page Shield effect: read questions: - What third-party hosts are my pages making connections to? - Can I see only malicious connections first, or filter them by page URL? - Is there a way to export Page Shield connections as CSV? instructions: - text: List Page Shield connections on zone {zone} for hosts {hosts}. slots: zone: path.zone_id hosts: query.hosts - text: Show outbound connections detected on page {page_url}, malicious ones first. slots: page_url: query.page_url - text: Export all detected page connections with status {status} as CSV. slots: status: query.status method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/connections/{connection_id}'].get update: x-apievangelist-phrasing: intent: Get a connection detected by Page Shield effect: read questions: - When was a specific outbound connection first and last seen by Page Shield? - Is one detected connection flagged as malicious? instructions: - text: Get Page Shield connection {connection} on zone {zone}. slots: connection: path.connection_id zone: path.zone_id - text: Show details for detected connection {connection}. slots: connection: path.connection_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/policies'].get update: x-apievangelist-phrasing: intent: List Page Shield policies effect: read questions: - Which Content Security Policy rules has Page Shield got configured for my zone? - What Page Shield policies exist and are they enabled? instructions: - text: List all Page Shield policies on zone {zone}. slots: zone: path.zone_id - text: Show my Page Shield CSP policies. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/policies'].post update: x-apievangelist-phrasing: intent: Create a Page Shield policy effect: write questions: - How do I create a Page Shield policy that only allows scripts from my own domain? - Can I write a new Page Shield policy in log mode before enforcing it? instructions: - text: Create a Page Shield policy on zone {zone} with action {action} and value {value}. slots: zone: path.zone_id action: requestBody.action value: requestBody.value - text: Add a new Page Shield policy described as {description} that applies when {expression}. slots: description: requestBody.description expression: requestBody.expression method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/policies/{policy_id}'].get update: x-apievangelist-phrasing: intent: Get a Page Shield policy effect: read questions: - What does a particular Page Shield policy allow and where does it apply? - Is an existing Page Shield policy set to allow or log? instructions: - text: Get Page Shield policy {policy} on zone {zone}. slots: policy: path.policy_id zone: path.zone_id - text: Show the expression and CSP value of Page Shield policy {policy}. slots: policy: path.policy_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/policies/{policy_id}'].put update: x-apievangelist-phrasing: intent: Update a Page Shield policy effect: write questions: - Can I change an existing Page Shield policy from log to allow? - How do I edit the expression on a Page Shield policy I already created? instructions: - text: Update Page Shield policy {policy} on zone {zone} to action {action}. slots: policy: path.policy_id zone: path.zone_id action: requestBody.action - text: Disable existing Page Shield policy {policy} by setting enabled to {enabled}. slots: policy: path.policy_id enabled: requestBody.enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/policies/{policy_id}'].delete update: x-apievangelist-phrasing: intent: Delete a Page Shield policy effect: destructive questions: - Can I permanently remove a Page Shield policy? - What deletes a CSP policy from Page Shield? instructions: - text: Delete Page Shield policy {policy} from zone {zone}. slots: policy: path.policy_id zone: path.zone_id - text: Remove the Page Shield policy {policy}. slots: policy: path.policy_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/scripts'].get update: x-apievangelist-phrasing: intent: List scripts detected by Page Shield effect: read questions: - Which JavaScript files are loading on my site's pages? - Can I list detected scripts without duplicates and with malicious ones on top? - Is it possible to filter detected scripts by the page they run on? instructions: - text: List scripts Page Shield detected on zone {zone} for page {page_url}. slots: zone: path.zone_id page_url: query.page_url - text: Show detected scripts loaded from hosts {hosts}, excluding duplicates. slots: hosts: query.hosts - text: Export all detected scripts with status {status} to CSV. slots: status: query.status method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/page_shield/scripts/{script_id}'].get update: x-apievangelist-phrasing: intent: Get a script detected by Page Shield effect: read questions: - Is a particular JavaScript file on my site considered malicious by Page Shield? - What versions and hashes has Page Shield recorded for one script? instructions: - text: Get Page Shield script {script} on zone {zone}. slots: script: path.script_id zone: path.zone_id - text: Show the details and malicious score of detected script {script}. slots: script: path.script_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/pagerules'].get update: x-apievangelist-phrasing: intent: List Page Rules in a zone effect: read questions: - What Page Rules do I have on my site and in what priority? - Can I list only the active Page Rules? instructions: - text: List Page Rules on zone {zone} with status {status}. slots: zone: path.zone_id status: query.status - text: Show all my Page Rules ordered by {order}. slots: order: query.order method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/pagerules'].post update: x-apievangelist-phrasing: intent: Create a Page Rule effect: write questions: - How do I add a Page Rule that forwards one URL pattern to another? - Can I create a Page Rule that caches everything under a path? instructions: - text: Create a Page Rule on zone {zone} matching {targets} with actions {actions}. slots: zone: path.zone_id targets: requestBody.targets actions: requestBody.actions - text: Add a new Page Rule for {targets} at priority {priority} doing {actions}. slots: targets: requestBody.targets priority: requestBody.priority actions: requestBody.actions method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/pagerules/{pagerule_id}'].get update: x-apievangelist-phrasing: intent: Get a Page Rule effect: read questions: - What URL pattern and actions does a given Page Rule have? - Is a specific Page Rule active or disabled? instructions: - text: Get Page Rule {rule} on zone {zone}. slots: rule: path.pagerule_id zone: path.zone_id - text: Show the targets and actions of Page Rule {rule}. slots: rule: path.pagerule_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/pagerules/{pagerule_id}'].put update: x-apievangelist-phrasing: intent: Replace a Page Rule's full configuration effect: write questions: - Can I overwrite a Page Rule entirely with a new target and set of actions? - Does replacing a Page Rule drop any settings I leave out of the request? instructions: - text: Replace Page Rule {rule} on zone {zone} with targets {targets} and actions {actions}. slots: rule: path.pagerule_id zone: path.zone_id targets: requestBody.targets actions: requestBody.actions - text: Fully overwrite the configuration of Page Rule {rule} using actions {actions} and targets {targets}. slots: rule: path.pagerule_id actions: requestBody.actions targets: requestBody.targets method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/pagerules/{pagerule_id}'].delete update: x-apievangelist-phrasing: intent: Delete a Page Rule effect: destructive questions: - How can I get rid of a Page Rule I no longer need? - What removes a Page Rule from my zone permanently? instructions: - text: Delete Page Rule {rule} from zone {zone}. slots: rule: path.pagerule_id zone: path.zone_id - text: Remove Page Rule {rule}. slots: rule: path.pagerule_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/pagerules/{pagerule_id}'].patch update: x-apievangelist-phrasing: intent: Edit selected fields of a Page Rule effect: write questions: - Can I change just the status or priority of a Page Rule without resending everything? - How do I pause one Page Rule temporarily? instructions: - text: Set Page Rule {rule} on zone {zone} to status {status}. slots: rule: path.pagerule_id zone: path.zone_id status: requestBody.status - text: Change only the priority of Page Rule {rule} to {priority}. slots: rule: path.pagerule_id priority: requestBody.priority method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/pagerules/settings'].get update: x-apievangelist-phrasing: intent: List settings Page Rules can apply effect: read questions: - Which actions can a Page Rule apply to matching requests on my zone? - What settings are available to use inside a Page Rule? instructions: - text: List the available Page Rules settings for zone {zone}. slots: zone: path.zone_id - text: Show every action type I can put in a Page Rule. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/purge_cache'].post update: x-apievangelist-phrasing: intent: Purge cached content effect: destructive questions: - How do I clear everything from the Cloudflare cache for my site? - Can I purge just a few URLs instead of the whole cache? - Which headers must I include to purge files cached with a device type or country cache key? instructions: - text: Purge all cached files for zone {zone}. slots: zone: path.zone_id - text: Clear the edge cache for my zone {zone} after the deploy. slots: zone: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets'].get update: x-apievangelist-phrasing: intent: List a zone's rulesets effect: read questions: - What rulesets are deployed at the zone level on my site? - Which phases have custom or managed rulesets attached to this zone? instructions: - text: List all zone-level rulesets on zone {zone}. slots: zone: path.zone_id - text: Show me every ruleset configured for this zone. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets'].post update: x-apievangelist-phrasing: intent: Create a zone ruleset effect: write questions: - How do I create a new ruleset scoped to one zone? - Can I build a zone ruleset for a specific phase with its own list of rules? instructions: - text: Create a zone ruleset named {name} in phase {phase} on zone {zone} with rules {rules}. slots: name: requestBody.name phase: requestBody.phase zone: path.zone_id rules: requestBody.rules - text: Add a new {kind} ruleset called {name} to my zone. slots: kind: requestBody.kind name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}'].get update: x-apievangelist-phrasing: intent: Get the latest version of a zone ruleset effect: read questions: - What rules are in the current version of a zone ruleset? - Can I read a zone ruleset by its ID to check its phase and kind? instructions: - text: Get zone ruleset {ruleset} on zone {zone}. slots: ruleset: path.ruleset_id zone: path.zone_id - text: Show the latest rules in ruleset {ruleset}. slots: ruleset: path.ruleset_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}'].put update: x-apievangelist-phrasing: intent: Update a zone ruleset as a new version effect: write questions: - Does updating a zone ruleset create a new version rather than editing in place? - How do I replace the full list of rules in an existing zone ruleset? instructions: - text: Update zone ruleset {ruleset} on zone {zone} with rules {rules}. slots: ruleset: path.ruleset_id zone: path.zone_id rules: requestBody.rules - text: Change the description of ruleset {ruleset} to {description}. slots: ruleset: path.ruleset_id description: requestBody.description method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}'].delete update: x-apievangelist-phrasing: intent: Delete a zone ruleset and all versions effect: destructive questions: - Will deleting a zone ruleset remove all of its versions? - What wipes out a custom zone ruleset entirely? instructions: - text: Delete zone ruleset {ruleset} and all its versions from zone {zone}. slots: ruleset: path.ruleset_id zone: path.zone_id - text: Permanently remove ruleset {ruleset} from my zone. slots: ruleset: path.ruleset_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}/rules'].post update: x-apievangelist-phrasing: intent: Add a rule to a zone ruleset effect: write questions: - How do I add one more rule to an existing zone ruleset? - Can I choose where a new rule is inserted instead of appending it at the end? instructions: - text: Add a rule to zone ruleset {ruleset} on zone {zone}. slots: ruleset: path.ruleset_id zone: path.zone_id - text: Insert a new rule into ruleset {ruleset} at position {position}. slots: ruleset: path.ruleset_id position: requestBody.position method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}'].delete update: x-apievangelist-phrasing: intent: Delete a rule from a zone ruleset effect: destructive questions: - Can I remove a single rule from a zone ruleset without deleting the ruleset? - What removes one rule by ID from my zone ruleset? instructions: - text: Delete rule {rule} from zone ruleset {ruleset} on zone {zone}. slots: rule: path.rule_id ruleset: path.ruleset_id zone: path.zone_id - text: Remove rule {rule} from ruleset {ruleset}. slots: rule: path.rule_id ruleset: path.ruleset_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}'].patch update: x-apievangelist-phrasing: intent: Update a rule in a zone ruleset effect: write questions: - How do I edit one existing rule inside a zone ruleset? - Can I move an existing rule to a different position in the ruleset? instructions: - text: Update rule {rule} in zone ruleset {ruleset} on zone {zone}. slots: rule: path.rule_id ruleset: path.ruleset_id zone: path.zone_id - text: Move existing rule {rule} in ruleset {ruleset} to position {position}. slots: rule: path.rule_id ruleset: path.ruleset_id position: requestBody.position method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}/versions'].get update: x-apievangelist-phrasing: intent: List versions of a zone ruleset effect: read questions: - What is the version history of a zone ruleset? - How many versions has one of my zone rulesets gone through? instructions: - text: List the versions of zone ruleset {ruleset} on zone {zone}. slots: ruleset: path.ruleset_id zone: path.zone_id - text: Show the change history of ruleset {ruleset}. slots: ruleset: path.ruleset_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}'].get update: x-apievangelist-phrasing: intent: Get a specific zone ruleset version effect: read questions: - What did a zone ruleset look like at an earlier version? - Can I fetch an older version of a zone ruleset to compare rules? instructions: - text: Get version {version} of zone ruleset {ruleset} on zone {zone}. slots: version: path.ruleset_version ruleset: path.ruleset_id zone: path.zone_id - text: Show the rules in ruleset {ruleset} as of version {version}. slots: ruleset: path.ruleset_id version: path.ruleset_version method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}'].delete update: x-apievangelist-phrasing: intent: Delete a zone ruleset version effect: destructive questions: - Can I delete one old version of a zone ruleset but keep the rest? - What removes a single version from a zone ruleset's history? instructions: - text: Delete version {version} of zone ruleset {ruleset} on zone {zone}. slots: version: path.ruleset_version ruleset: path.ruleset_id zone: path.zone_id - text: Remove old version {version} from ruleset {ruleset}. slots: version: path.ruleset_version ruleset: path.ruleset_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint'].get update: x-apievangelist-phrasing: intent: Get a zone's entry point ruleset for a phase effect: read questions: - What rules run in my zone's entry point ruleset for the request firewall phase? - Which ruleset is the entry point for a given phase on this zone? instructions: - text: Get the entry point ruleset for phase {phase} on zone {zone}. slots: phase: path.ruleset_phase zone: path.zone_id - text: Show the current zone entry point rules for the {phase} phase. slots: phase: path.ruleset_phase method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint'].put update: x-apievangelist-phrasing: intent: Update a zone's entry point ruleset for a phase effect: write questions: - How do I set the rules that run at the entry point of a phase on my zone? - Does changing a zone entry point ruleset create a new version of it? instructions: - text: Update the zone {zone} entry point ruleset for phase {phase} with rules {rules}. slots: zone: path.zone_id phase: path.ruleset_phase rules: requestBody.rules - text: Replace the entry point rules for phase {phase} on my zone. slots: phase: path.ruleset_phase method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions'].get update: x-apievangelist-phrasing: intent: List versions of a zone entry point ruleset effect: read questions: - What is the version history of my zone's entry point ruleset for a phase? - How has the phase entry point ruleset changed over time? instructions: - text: List versions of the entry point ruleset for phase {phase} on zone {zone}. slots: phase: path.ruleset_phase zone: path.zone_id - text: Show the entry point history for phase {phase}. slots: phase: path.ruleset_phase method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}'].get update: x-apievangelist-phrasing: intent: Get a version of a zone entry point ruleset effect: read questions: - Can I look at an older version of a phase entry point ruleset on my zone? - What rules did the entry point for a phase contain at a past version? instructions: - text: Get version {version} of the phase {phase} entry point ruleset on zone {zone}. slots: version: path.ruleset_version phase: path.ruleset_phase zone: path.zone_id - text: Show entry point version {version} for phase {phase}. slots: version: path.ruleset_version phase: path.ruleset_phase method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/force_axfr'].post update: x-apievangelist-phrasing: intent: Force a zone transfer from the primary effect: write questions: - How do I make my secondary zone pull a fresh copy from the primary nameserver right now? - Can I trigger an AXFR on demand instead of waiting for the refresh interval? instructions: - text: Force an AXFR zone transfer for secondary zone {zone}. slots: zone: path.zone_id - text: Request an immediate full transfer from my primary nameservers. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/incoming'].get update: x-apievangelist-phrasing: intent: Get incoming secondary zone configuration effect: read questions: - Which primary peers and refresh interval is my secondary zone using? - What is the incoming zone transfer setup for this zone? instructions: - text: Get the incoming zone transfer configuration for zone {zone}. slots: zone: path.zone_id - text: Show my secondary DNS peers and auto refresh seconds. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/incoming'].put update: x-apievangelist-phrasing: intent: Update incoming secondary zone configuration effect: write questions: - Can I change the primary peers my existing secondary zone pulls from? - How do I adjust the auto refresh interval on an existing secondary zone? instructions: - text: Update secondary zone {zone} to transfer from peers {peers} every {seconds} seconds. slots: zone: path.zone_id peers: requestBody.peers seconds: requestBody.auto_refresh_seconds - text: Change the existing incoming transfer config {id} named {name} to use peers {peers}. slots: id: requestBody.id name: requestBody.name peers: requestBody.peers method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/incoming'].post update: x-apievangelist-phrasing: intent: Create incoming secondary zone configuration effect: write questions: - How do I set up my zone as a secondary that receives transfers from an external primary? - What do I need to supply to start incoming zone transfers for the first time? instructions: - text: Create an incoming zone transfer config {name} on zone {zone} from peers {peers} refreshing every {seconds} seconds. slots: name: requestBody.name zone: path.zone_id peers: requestBody.peers seconds: requestBody.auto_refresh_seconds - text: Set up secondary DNS for the first time with config id {id} and peers {peers}. slots: id: requestBody.id peers: requestBody.peers method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/incoming'].delete update: x-apievangelist-phrasing: intent: Delete incoming secondary zone configuration effect: destructive questions: - How do I stop my zone from acting as a secondary and receiving transfers? - Can I remove the incoming zone transfer configuration? instructions: - text: Delete the incoming zone transfer configuration for zone {zone}. slots: zone: path.zone_id - text: Remove my secondary DNS setup. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing'].get update: x-apievangelist-phrasing: intent: Get outgoing primary zone configuration effect: read questions: - Which secondary nameservers is my primary zone configured to send transfers to? - What does the outgoing zone transfer configuration look like? instructions: - text: Get the outgoing zone transfer configuration for primary zone {zone}. slots: zone: path.zone_id - text: Show which peers receive transfers from my primary zone. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing'].put update: x-apievangelist-phrasing: intent: Update outgoing primary zone configuration effect: write questions: - Can I change which secondary peers receive transfers from my existing primary zone? - How do I rename an existing outgoing transfer configuration? instructions: - text: Update primary zone {zone} to send outgoing transfers to peers {peers}. slots: zone: path.zone_id peers: requestBody.peers - text: Change existing outgoing config {id} to name {name} with peers {peers}. slots: id: requestBody.id name: requestBody.name peers: requestBody.peers method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing'].post update: x-apievangelist-phrasing: intent: Create outgoing primary zone configuration effect: write questions: - How do I make my zone a primary that sends transfers to external secondary nameservers? - What is needed to set up outgoing zone transfers for the first time? instructions: - text: Create an outgoing zone transfer config {name} on zone {zone} for peers {peers}. slots: name: requestBody.name zone: path.zone_id peers: requestBody.peers - text: Set up my zone as a DNS primary with config id {id} sending to {peers}. slots: id: requestBody.id peers: requestBody.peers method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing'].delete update: x-apievangelist-phrasing: intent: Delete outgoing primary zone configuration effect: destructive questions: - Can I remove the outgoing zone transfer setup from my primary zone? - What deletes the primary zone configuration for secondary DNS? instructions: - text: Delete the outgoing zone transfer configuration for zone {zone}. slots: zone: path.zone_id - text: Remove my primary zone transfer configuration entirely. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing/disable'].post update: x-apievangelist-phrasing: intent: Disable outgoing zone transfers effect: destructive questions: - How do I pause transfers from my primary zone to its secondaries? - Does turning off outgoing zone transfers clear the IXFR backlog? instructions: - text: Disable outgoing zone transfers for primary zone {zone}. slots: zone: path.zone_id - text: Stop sending zone transfers to my secondary nameservers and clear the backlog. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing/enable'].post update: x-apievangelist-phrasing: intent: Enable outgoing zone transfers effect: write questions: - How do I start sending transfers from my primary zone to secondary nameservers? - Can I turn outgoing zone transfers back on after disabling them? instructions: - text: Enable outgoing zone transfers for primary zone {zone}. slots: zone: path.zone_id - text: Resume zone transfers to my secondary peers. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing/force_notify'].post update: x-apievangelist-phrasing: intent: Send a DNS NOTIFY to secondaries effect: write questions: - How can I tell my secondary nameservers right away that the primary zone changed? - Is there a way to force a NOTIFY and clear the IXFR backlog? instructions: - text: Force a DNS NOTIFY to the secondaries of primary zone {zone}. slots: zone: path.zone_id - text: Notify my secondary nameservers of changes now. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/secondary_dns/outgoing/status'].get update: x-apievangelist-phrasing: intent: Get outgoing zone transfer status effect: read questions: - Are outgoing zone transfers from my primary zone currently enabled? - What is the transfer status of my primary zone? instructions: - text: Get the outgoing zone transfer status for zone {zone}. slots: zone: path.zone_id - text: Check whether my primary zone is sending transfers. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings'].get update: x-apievangelist-phrasing: intent: Get all settings for a zone effect: read questions: - What are all the current settings on my zone in one call? - Can I see every zone setting and whether it is editable? instructions: - text: Get all zone settings for zone {zone}. slots: zone: path.zone_id - text: Dump every setting currently applied to my site. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings'].patch update: x-apievangelist-phrasing: intent: Edit several zone settings at once effect: write questions: - Can I change several zone settings in a single request? - How do I bulk-update multiple settings on a zone? instructions: - text: Apply the settings {items} to zone {zone} in one request. slots: items: requestBody.items zone: path.zone_id - text: Bulk edit my zone's settings with {items}. slots: items: requestBody.items method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/0rtt'].get update: x-apievangelist-phrasing: intent: Get the 0-RTT session resumption setting effect: read questions: - Is 0-RTT session resumption enabled for my zone? - What is the current 0-RTT value on this site? instructions: - text: Get the 0-RTT setting for zone {zone}. slots: zone: path.zone_id - text: Check whether 0-RTT resumption is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/0rtt'].patch update: x-apievangelist-phrasing: intent: Change 0-RTT session resumption effect: write questions: - How do I enable 0-RTT so returning visitors reconnect faster? - Can I turn off 0-RTT session resumption for my zone? instructions: - text: Set 0-RTT session resumption to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn 0-RTT {value} for my site. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/advanced_ddos'].get update: x-apievangelist-phrasing: intent: Check Advanced DDoS protection status effect: read questions: - Is advanced DDoS protection active on my zone? - Can I change the Advanced DDoS setting, or is it read-only? instructions: - text: Get the Advanced DDoS setting for zone {zone}. slots: zone: path.zone_id - text: Show whether my site has advanced DDoS attack protection. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/always_online'].get update: x-apievangelist-phrasing: intent: Get the Always Online setting effect: read questions: - Will visitors see an archived copy of my pages if my origin goes down? - Is Always Online currently enabled for this zone? instructions: - text: Get the Always Online setting for zone {zone}. slots: zone: path.zone_id - text: Check if Always Online is serving cached copies when my server is offline. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/always_online'].patch update: x-apievangelist-phrasing: intent: Turn Always Online on or off effect: write questions: - Can I have Cloudflare serve Wayback Machine copies of my pages when my server is down? - How do I disable Always Online for my site? instructions: - text: Set Always Online to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn Always Online {value} so archived pages show during outages. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/always_use_https'].get update: x-apievangelist-phrasing: intent: Get the Always Use HTTPS setting effect: read questions: - Are plain http requests to my site being redirected to https? - Is Always Use HTTPS enabled on this zone? instructions: - text: Get the Always Use HTTPS setting for zone {zone}. slots: zone: path.zone_id - text: Check whether http URLs get a 301 to https. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/always_use_https'].patch update: x-apievangelist-phrasing: intent: Turn Always Use HTTPS on or off effect: write questions: - How do I force every http request on my site to redirect to https? - Can I stop the automatic 301 redirect from http to https? instructions: - text: Set Always Use HTTPS to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Redirect all http traffic to https by turning Always Use HTTPS {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/automatic_https_rewrites'].get update: x-apievangelist-phrasing: intent: Get the Automatic HTTPS Rewrites setting effect: read questions: - Is Automatic HTTPS Rewrites fixing mixed content links on my pages? - What is the current Automatic HTTPS Rewrites value? instructions: - text: Get the Automatic HTTPS Rewrites setting for zone {zone}. slots: zone: path.zone_id - text: Check whether mixed-content http links are rewritten to https. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/automatic_https_rewrites'].patch update: x-apievangelist-phrasing: intent: Turn Automatic HTTPS Rewrites on or off effect: write questions: - Can I have insecure http links in my HTML rewritten to https automatically? - What switches Automatic HTTPS Rewrites off for a zone? instructions: - text: Set Automatic HTTPS Rewrites to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn Automatic HTTPS Rewrites {value} to fix mixed content. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/automatic_platform_optimization'].get update: x-apievangelist-phrasing: intent: Get the APO for WordPress setting effect: read questions: - Is Automatic Platform Optimization for WordPress enabled on my site? - What APO options (cache by device, hostnames) are set for this zone? instructions: - text: Get the Automatic Platform Optimization setting for zone {zone}. slots: zone: path.zone_id - text: Show my WordPress APO configuration. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/automatic_platform_optimization'].patch update: x-apievangelist-phrasing: intent: Change APO for WordPress effect: write questions: - How do I enable Automatic Platform Optimization for my WordPress site? - Can I update which hostnames APO for WordPress applies to? instructions: - text: Set Automatic Platform Optimization on zone {zone} to {value}. slots: zone: path.zone_id value: requestBody.value - text: Update my WordPress APO settings to {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/brotli'].get update: x-apievangelist-phrasing: intent: Get the Brotli compression setting effect: read questions: - Is Brotli compression turned on for my zone? - Are visitors that support Brotli getting Brotli-compressed assets? instructions: - text: Get the Brotli setting for zone {zone}. slots: zone: path.zone_id - text: Check if Brotli compression is enabled. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/brotli'].patch update: x-apievangelist-phrasing: intent: Turn Brotli compression on or off effect: write questions: - Can I enable Brotli compression for browsers that support it? - How do I switch off Brotli on my site? instructions: - text: Set Brotli to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn Brotli compression {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/browser_cache_ttl'].get update: x-apievangelist-phrasing: intent: Get the Browser Cache TTL effect: read questions: - How long do visitors' browsers keep my cached resources? - Is my Browser Cache TTL set to respect existing headers? instructions: - text: Get the Browser Cache TTL for zone {zone}. slots: zone: path.zone_id - text: Show how many seconds browsers cache my assets. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/browser_cache_ttl'].patch update: x-apievangelist-phrasing: intent: Change the Browser Cache TTL effect: write questions: - Can I make browsers cache my static files for longer? - What happens if I set the Browser Cache TTL to 0? instructions: - text: Set Browser Cache TTL to {seconds} seconds on zone {zone}. slots: seconds: requestBody.value zone: path.zone_id - text: Change the browser cache lifetime to {seconds} seconds. slots: seconds: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/browser_check'].get update: x-apievangelist-phrasing: intent: Get the Browser Integrity Check setting effect: read questions: - Is Browser Integrity Check blocking requests with suspicious headers on my site? - What is the current Browser Check value for this zone? instructions: - text: Get the Browser Integrity Check setting for zone {zone}. slots: zone: path.zone_id - text: Check whether browser integrity checking is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/browser_check'].patch update: x-apievangelist-phrasing: intent: Turn Browser Integrity Check on or off effect: write questions: - Can I challenge visitors whose requests lack a user agent or use abused headers? - How do I disable Browser Integrity Check for an API zone? instructions: - text: Set Browser Integrity Check to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn browser integrity checks {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/cache_level'].get update: x-apievangelist-phrasing: intent: Get the Cache Level setting effect: read questions: - Is my zone caching with basic, simplified or aggressive cache level? - Does the cache ignore query strings on my site? instructions: - text: Get the Cache Level setting for zone {zone}. slots: zone: path.zone_id - text: Show which cache level my site uses. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/cache_level'].patch update: x-apievangelist-phrasing: intent: Change the Cache Level effect: write questions: - Can I switch my cache level to aggressive so query strings don't bust the cache? - How do I set caching to ignore query strings? instructions: - text: Set Cache Level to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Change my site's caching level to {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/challenge_ttl'].get update: x-apievangelist-phrasing: intent: Get the Challenge Passage TTL effect: read questions: - How long can a visitor browse after passing a challenge before seeing another? - What is the Challenge TTL on this zone? instructions: - text: Get the Challenge TTL for zone {zone}. slots: zone: path.zone_id - text: Show how long a solved challenge stays valid. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/challenge_ttl'].patch update: x-apievangelist-phrasing: intent: Change the Challenge Passage TTL effect: write questions: - Can I make visitors re-solve challenges less often? - How do I shorten the time a passed CAPTCHA stays valid? instructions: - text: Set Challenge TTL to {seconds} seconds on zone {zone}. slots: seconds: requestBody.value zone: path.zone_id - text: Let visitors keep access for {seconds} seconds after passing a challenge. slots: seconds: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ciphers'].get update: x-apievangelist-phrasing: intent: Get the allowed TLS cipher suites effect: read questions: - Which TLS cipher suites does my zone allow at the edge? - Have I restricted the cipher list on this site? instructions: - text: Get the ciphers setting for zone {zone}. slots: zone: path.zone_id - text: List the cipher suites my edge certificate accepts. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ciphers'].patch update: x-apievangelist-phrasing: intent: Change the allowed TLS cipher suites effect: write questions: - Can I restrict my site to a specific list of strong cipher suites? - How do I drop weak ciphers from my zone's TLS configuration? instructions: - text: Set the allowed ciphers on zone {zone} to {ciphers}. slots: zone: path.zone_id ciphers: requestBody.value - text: Restrict TLS to cipher suites {ciphers}. slots: ciphers: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/development_mode'].get update: x-apievangelist-phrasing: intent: Get the Development Mode setting effect: read questions: - Is Development Mode currently bypassing the cache on my zone? - How much time is left before Development Mode switches itself off? instructions: - text: Get the Development Mode setting for zone {zone}. slots: zone: path.zone_id - text: Check whether dev mode is on and when it expires. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/development_mode'].patch update: x-apievangelist-phrasing: intent: Turn Development Mode on or off effect: write questions: - Can I temporarily bypass the cache while I change my site? - How do I turn Development Mode off early? instructions: - text: Set Development Mode to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn dev mode {value} so I can see origin changes immediately. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/early_hints'].get update: x-apievangelist-phrasing: intent: Get the Early Hints setting effect: read questions: - Is my zone sending 103 Early Hints responses? - What is the Early Hints value on this site? instructions: - text: Get the Early Hints setting for zone {zone}. slots: zone: path.zone_id - text: Check if 103 Early Hints are enabled. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/early_hints'].patch update: x-apievangelist-phrasing: intent: Turn Early Hints on or off effect: write questions: - Can I speed up page loads by sending 103 responses with Link headers? - How do I disable Early Hints on my zone? instructions: - text: Set Early Hints to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn 103 Early Hints {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/email_obfuscation'].get update: x-apievangelist-phrasing: intent: Get the Email Obfuscation setting effect: read questions: - Are email addresses on my pages hidden from scraping bots? - Is Email Obfuscation enabled for this zone? instructions: - text: Get the Email Obfuscation setting for zone {zone}. slots: zone: path.zone_id - text: Check whether email addresses on my site are obfuscated. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/email_obfuscation'].patch update: x-apievangelist-phrasing: intent: Turn Email Obfuscation on or off effect: write questions: - Can I hide email addresses on my web pages from bots while keeping them visible to people? - What turns off Email Obfuscation? instructions: - text: Set Email Obfuscation to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn email address obfuscation {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/fonts'].get update: x-apievangelist-phrasing: intent: Get the Cloudflare Fonts setting effect: read questions: - Are Google-hosted fonts on my site being served from my own domain? - Is the Fonts feature enabled for this zone? instructions: - text: Get the Fonts setting for zone {zone}. slots: zone: path.zone_id - text: Check whether font delivery optimization is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/fonts'].patch update: x-apievangelist-phrasing: intent: Turn Cloudflare Fonts on or off effect: write questions: - Can I deliver Google Fonts from my own domain for better privacy and speed? - How do I disable Cloudflare Fonts? instructions: - text: Set Fonts to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn font delivery from my own domain {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/h2_prioritization'].get update: x-apievangelist-phrasing: intent: Get HTTP/2 Edge Prioritization effect: read questions: - Is HTTP/2 Edge Prioritization enabled on my zone? - What prioritization mode is the edge using for HTTP/2 streams? instructions: - text: Get the HTTP/2 Edge Prioritization setting for zone {zone}. slots: zone: path.zone_id - text: Show my HTTP/2 prioritization value. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/h2_prioritization'].patch update: x-apievangelist-phrasing: intent: Change HTTP/2 Edge Prioritization effect: write questions: - Can I turn on enhanced HTTP/2 prioritization at the edge? - How do I switch off HTTP/2 Edge Prioritization? instructions: - text: Set HTTP/2 Edge Prioritization to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Change HTTP/2 stream prioritization to {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/hotlink_protection'].get update: x-apievangelist-phrasing: intent: Get the Hotlink Protection setting effect: read questions: - Are other sites prevented from embedding my images? - Is Hotlink Protection on for this zone? instructions: - text: Get the Hotlink Protection setting for zone {zone}. slots: zone: path.zone_id - text: Check whether image hotlinking is blocked. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/hotlink_protection'].patch update: x-apievangelist-phrasing: intent: Turn Hotlink Protection on or off effect: write questions: - Can I stop other websites from using my bandwidth by linking to my images? - How do I allow image hotlinking again? instructions: - text: Set Hotlink Protection to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn image hotlink blocking {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/http2'].get update: x-apievangelist-phrasing: intent: Get the HTTP/2 setting effect: read questions: - Is HTTP/2 enabled for visitors to my zone? - What is the current HTTP2 value? instructions: - text: Get the HTTP2 setting for zone {zone}. slots: zone: path.zone_id - text: Check if visitors can connect over HTTP/2. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/http2'].patch update: x-apievangelist-phrasing: intent: Turn HTTP/2 on or off effect: write questions: - Can I disable HTTP/2 for my site's visitors? - What turns HTTP/2 back on for a zone? instructions: - text: Set HTTP2 to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn HTTP/2 support {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/http3'].get update: x-apievangelist-phrasing: intent: Get the HTTP/3 setting effect: read questions: - Is HTTP/3 over QUIC enabled on my zone? - What is the current HTTP3 value? instructions: - text: Get the HTTP3 setting for zone {zone}. slots: zone: path.zone_id - text: Check whether HTTP/3 with QUIC is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/http3'].patch update: x-apievangelist-phrasing: intent: Turn HTTP/3 on or off effect: write questions: - Can I enable HTTP/3 over QUIC for my visitors? - How do I disable HTTP/3 on a zone? instructions: - text: Set HTTP3 to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn HTTP/3 support {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/image_resizing'].get update: x-apievangelist-phrasing: intent: Get the Image Resizing setting effect: read questions: - Is on-demand Image Resizing available on my zone? - What is the current Image Resizing value? instructions: - text: Get the Image Resizing setting for zone {zone}. slots: zone: path.zone_id - text: Check whether image resizing and conversion is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/image_resizing'].patch update: x-apievangelist-phrasing: intent: Turn Image Resizing on or off effect: write questions: - Can I let my site resize and convert images on the fly at the edge? - What turns Image Resizing off for my zone? instructions: - text: Set Image Resizing to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn on-demand image resizing {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ip_geolocation'].get update: x-apievangelist-phrasing: intent: Get the IP Geolocation setting effect: read questions: - Is my origin receiving the visitor's country code header? - Is IP Geolocation enabled on this zone? instructions: - text: Get the IP Geolocation setting for zone {zone}. slots: zone: path.zone_id - text: Check whether visitor country codes are passed to my server. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ip_geolocation'].patch update: x-apievangelist-phrasing: intent: Turn IP Geolocation on or off effect: write questions: - Can I have visitors geolocated and their country code passed to my origin? - How do I stop sending the country header to my server? instructions: - text: Set IP Geolocation to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn visitor country geolocation {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ipv6'].get update: x-apievangelist-phrasing: intent: Get the IPv6 setting effect: read questions: - Is IPv6 enabled on my proxied subdomains? - What is the IPv6 compatibility value for this zone? instructions: - text: Get the IPv6 setting for zone {zone}. slots: zone: path.zone_id - text: Check whether my site is reachable over IPv6. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ipv6'].patch update: x-apievangelist-phrasing: intent: Turn IPv6 on or off effect: write questions: - Can I enable IPv6 on all my proxied subdomains? - What disables IPv6 compatibility for a zone? instructions: - text: Set IPv6 to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn IPv6 support {value} for my subdomains. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/min_tls_version'].get update: x-apievangelist-phrasing: intent: Get the minimum TLS version effect: read questions: - What is the oldest TLS version my site accepts? - Does my zone still allow TLS 1.0 connections? instructions: - text: Get the minimum TLS version for zone {zone}. slots: zone: path.zone_id - text: Show the lowest TLS version visitors can use. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/min_tls_version'].patch update: x-apievangelist-phrasing: intent: Change the minimum TLS version effect: write questions: - Can I require TLS 1.2 or higher for all visitors? - How do I block connections using old TLS versions? instructions: - text: Set the minimum TLS version to {version} on zone {zone}. slots: version: requestBody.value zone: path.zone_id - text: Require at least TLS {version} for my site. slots: version: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/minify'].get update: x-apievangelist-phrasing: intent: Get the Auto Minify setting effect: read questions: - Which asset types (CSS, HTML, JS) are being minified on my site? - Is Auto Minify on for this zone? instructions: - text: Get the Minify setting for zone {zone}. slots: zone: path.zone_id - text: Show whether CSS, HTML and JavaScript are auto-minified. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/minify'].patch update: x-apievangelist-phrasing: intent: Change Auto Minify for CSS, HTML and JS effect: write questions: - Can I minify only JavaScript but leave HTML untouched? - How do I turn Auto Minify off for CSS? instructions: - text: Set Auto Minify on zone {zone} to {value}. slots: zone: path.zone_id value: requestBody.value - text: Change which asset types get minified to {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/mirage'].get update: x-apievangelist-phrasing: intent: Get the Mirage image optimization setting effect: read questions: - Is Mirage optimizing images for mobile visitors on my site? - What is the Mirage value for this zone? instructions: - text: Get the Mirage setting for zone {zone}. slots: zone: path.zone_id - text: Check whether Mirage mobile image loading is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/mirage'].patch update: x-apievangelist-phrasing: intent: Turn Mirage on or off effect: write questions: - Can I enable Mirage to speed up image loading on mobile devices? - What switches Mirage off? instructions: - text: Set Mirage to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn Mirage mobile image optimization {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/mobile_redirect'].get update: x-apievangelist-phrasing: intent: Get the Mobile Redirect setting effect: read questions: - Are mobile visitors being redirected to my mobile subdomain? - Which subdomain does Mobile Redirect send phones to? instructions: - text: Get the Mobile Redirect setting for zone {zone}. slots: zone: path.zone_id - text: Show where mobile visitors are redirected. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/mobile_redirect'].patch update: x-apievangelist-phrasing: intent: Change the Mobile Redirect setting effect: write questions: - Can I send visitors on phones to a mobile-optimized subdomain automatically? - What turns off mobile redirection for my site? instructions: - text: Set Mobile Redirect on zone {zone} to {value}. slots: zone: path.zone_id value: requestBody.value - text: Redirect mobile devices using the configuration {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/nel'].get update: x-apievangelist-phrasing: intent: Get the Network Error Logging setting effect: read questions: - Is Network Error Logging reporting enabled on my zone? - What is the current NEL value for this site? instructions: - text: Get the Network Error Logging setting for zone {zone}. slots: zone: path.zone_id - text: Check whether NEL reports are being collected. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/nel'].patch update: x-apievangelist-phrasing: intent: Turn Network Error Logging on or off effect: write questions: - Can I enable Network Error Logging so browsers report connection failures? - How do I disable NEL on a zone? instructions: - text: Set Network Error Logging to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn NEL reporting {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/opportunistic_encryption'].get update: x-apievangelist-phrasing: intent: Get the Opportunistic Encryption setting effect: read questions: - Is Opportunistic Encryption advertised to browsers visiting over http? - What is the Opportunistic Encryption value here? instructions: - text: Get the Opportunistic Encryption setting for zone {zone}. slots: zone: path.zone_id - text: Check if opportunistic encryption is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/opportunistic_encryption'].patch update: x-apievangelist-phrasing: intent: Turn Opportunistic Encryption on or off effect: write questions: - Can I let browsers use encrypted connections even for http URLs? - What turns Opportunistic Encryption off? instructions: - text: Set Opportunistic Encryption to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn opportunistic encryption {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/opportunistic_onion'].get update: x-apievangelist-phrasing: intent: Get the Opportunistic Onion setting effect: read questions: - Are Tor visitors being offered my site's onion service? - Is Opportunistic Onion enabled on this zone? instructions: - text: Get the Opportunistic Onion setting for zone {zone}. slots: zone: path.zone_id - text: Check whether Tor users get an Alt-Svc onion header. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/opportunistic_onion'].patch update: x-apievangelist-phrasing: intent: Turn Opportunistic Onion on or off effect: write questions: - Can I let Tor visitors reach my site through onion services? - What disables the onion Alt-Svc header? instructions: - text: Set Opportunistic Onion to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn onion routing for Tor visitors {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/orange_to_orange'].get update: x-apievangelist-phrasing: intent: Get the Orange to Orange (O2O) setting effect: read questions: - Is my zone allowed to CNAME to another zone that is also proxied? - What is the O2O value for this site? instructions: - text: Get the Orange to Orange setting for zone {zone}. slots: zone: path.zone_id - text: Check whether O2O is enabled. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/orange_to_orange'].patch update: x-apievangelist-phrasing: intent: Turn Orange to Orange (O2O) on or off effect: write questions: - Can I point my zone via CNAME at another proxied zone on the same network? - How do I disable O2O? instructions: - text: Set Orange to Orange to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn O2O CNAME proxying {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/origin_error_page_pass_thru'].get update: x-apievangelist-phrasing: intent: Get the origin error page pass-through setting effect: read questions: - Will visitors see my own error pages on 502 and 504 origin errors? - Is origin error page pass-through enabled? instructions: - text: Get the origin error page pass-through setting for zone {zone}. slots: zone: path.zone_id - text: Check if my custom origin 502/504 pages are shown. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/origin_error_page_pass_thru'].patch update: x-apievangelist-phrasing: intent: Change origin error page pass-through effect: write questions: - Can I show my server's own error page instead of the default one on 502 or 504 errors? - What switches back to the default error page for origin failures? instructions: - text: Set origin error page pass-through to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn proxying of my own 502 and 504 pages {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/origin_max_http_version'].get update: x-apievangelist-phrasing: intent: Get the origin max HTTP version effect: read questions: - What is the highest HTTP version used to talk to my origin? - Is HTTP/2 to origin enabled for this zone? instructions: - text: Get the Origin Max HTTP Version for zone {zone}. slots: zone: path.zone_id - text: Show which HTTP version is used for origin connections. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/origin_max_http_version'].patch update: x-apievangelist-phrasing: intent: Change the origin max HTTP version effect: write questions: - Can I let the edge connect to my origin over HTTP/2? - How do I limit origin connections to HTTP/1.1? instructions: - text: Set Origin Max HTTP Version to {version} on zone {zone}. slots: version: requestBody.value zone: path.zone_id - text: Use HTTP version {version} as the maximum for origin connections. slots: version: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/polish'].get update: x-apievangelist-phrasing: intent: Get the Polish image optimization setting effect: read questions: - Is Polish compressing images on my site, and is it lossy or lossless? - What is the Polish value for this zone? instructions: - text: Get the Polish setting for zone {zone}. slots: zone: path.zone_id - text: Check the Polish image compression mode. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/polish'].patch update: x-apievangelist-phrasing: intent: Change Polish image optimization effect: write questions: - Can I set Polish to lossy compression to shrink images further? - What turns Polish off? instructions: - text: Set Polish to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Change Polish image compression to {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/prefetch_preload'].get update: x-apievangelist-phrasing: intent: Get the Prefetch Preload setting effect: read questions: - Is the edge prefetching URLs listed in my response headers? - Is Prefetch Preload enabled on my Enterprise zone? instructions: - text: Get the prefetch preload setting for zone {zone}. slots: zone: path.zone_id - text: Check whether header-listed URLs are prefetched. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/prefetch_preload'].patch update: x-apievangelist-phrasing: intent: Turn Prefetch Preload on or off effect: write questions: - Can I have URLs in my response headers prefetched into cache? - What disables prefetch preload on an Enterprise zone? instructions: - text: Set prefetch preload to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn URL prefetching from response headers {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/proxy_read_timeout'].get update: x-apievangelist-phrasing: intent: Get the proxy read timeout effect: read questions: - How long will the edge wait between two reads from my origin? - What is the proxy read timeout on this zone? instructions: - text: Get the proxy read timeout for zone {zone}. slots: zone: path.zone_id - text: Show the maximum wait between origin reads. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/proxy_read_timeout'].patch update: x-apievangelist-phrasing: intent: Change the proxy read timeout effect: write questions: - Can I give slow origin responses more time before the connection times out? - How do I raise the proxy read timeout? instructions: - text: Set the proxy read timeout to {seconds} on zone {zone}. slots: seconds: requestBody.value zone: path.zone_id - text: Allow up to {seconds} seconds between reads from my origin. slots: seconds: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/pseudo_ipv4'].get update: x-apievangelist-phrasing: intent: Get the Pseudo IPv4 setting effect: read questions: - Is Pseudo IPv4 adding an IPv4 header for IPv6 visitors? - What is the Pseudo IPv4 value on this zone? instructions: - text: Get the Pseudo IPv4 setting for zone {zone}. slots: zone: path.zone_id - text: Check how Pseudo IPv4 is configured. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/pseudo_ipv4'].patch update: x-apievangelist-phrasing: intent: Change the Pseudo IPv4 setting effect: write questions: - Can my origin receive a pseudo IPv4 address for visitors connecting over IPv6? - What turns Pseudo IPv4 off? instructions: - text: Set Pseudo IPv4 to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Change Pseudo IPv4 mode to {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/response_buffering'].get update: x-apievangelist-phrasing: intent: Get the Response Buffering setting effect: read questions: - Is the edge buffering whole responses from my origin before sending them? - Is Response Buffering enabled here? instructions: - text: Get the Response Buffering setting for zone {zone}. slots: zone: path.zone_id - text: Check whether origin responses are buffered. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/response_buffering'].patch update: x-apievangelist-phrasing: intent: Turn Response Buffering on or off effect: write questions: - Can I stream responses from my origin without buffering them? - How do I enable response buffering from the proxied server? instructions: - text: Set Response Buffering to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn origin response buffering {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/rocket_loader'].get update: x-apievangelist-phrasing: intent: Get the Rocket Loader setting effect: read questions: - Is Rocket Loader deferring JavaScript on my pages? - What is the Rocket Loader value for this zone? instructions: - text: Get the Rocket Loader setting for zone {zone}. slots: zone: path.zone_id - text: Check whether async JavaScript loading is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/rocket_loader'].patch update: x-apievangelist-phrasing: intent: Turn Rocket Loader on or off effect: write questions: - Can I load my page's JavaScript asynchronously so content renders first? - What turns Rocket Loader off if it breaks my scripts? instructions: - text: Set Rocket Loader to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn Rocket Loader {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/security_header'].get update: x-apievangelist-phrasing: intent: Get the HSTS security header setting effect: read questions: - Is HSTS enabled on my zone, and with what max-age? - Does my HSTS header include subdomains and preload? instructions: - text: Get the HSTS security header setting for zone {zone}. slots: zone: path.zone_id - text: Show my Strict-Transport-Security configuration. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/security_header'].patch update: x-apievangelist-phrasing: intent: Change the HSTS security header effect: write questions: - Can I turn on HSTS with a long max-age and subdomains included? - How do I change the Strict-Transport-Security header my site sends? instructions: - text: Set the HSTS security header on zone {zone} to {value}. slots: zone: path.zone_id value: requestBody.value - text: Update Strict-Transport-Security to {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/security_level'].get update: x-apievangelist-phrasing: intent: Get the Security Level setting effect: read questions: - What security level is my site using to challenge visitors? - Is my zone in I'm Under Attack mode? instructions: - text: Get the Security Level for zone {zone}. slots: zone: path.zone_id - text: Show the current security profile for my site. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/security_level'].patch update: x-apievangelist-phrasing: intent: Change the Security Level effect: write questions: - Can I raise my security level to challenge more suspicious visitors? - How do I switch my site to under attack mode? instructions: - text: Set Security Level to {level} on zone {zone}. slots: level: requestBody.value zone: path.zone_id - text: Change my site's security profile to {level}. slots: level: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/server_side_exclude'].get update: x-apievangelist-phrasing: intent: Get the Server Side Exclude setting effect: read questions: - Is Server Side Exclude hiding marked content from suspicious visitors? - What is the Server Side Exclude value on this zone? instructions: - text: Get the Server Side Exclude setting for zone {zone}. slots: zone: path.zone_id - text: Check whether SSE content hiding is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/server_side_exclude'].patch update: x-apievangelist-phrasing: intent: Turn Server Side Exclude on or off effect: write questions: - Can I hide sensitive page content from suspicious visitors but show it to real ones? - What disables Server Side Exclude? instructions: - text: Set Server Side Exclude to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn SSE content hiding {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/sort_query_string_for_cache'].get update: x-apievangelist-phrasing: intent: Get the query string sort setting effect: read questions: - Does my cache treat URLs with the same query parameters in a different order as one file? - Is query string sorting for cache enabled? instructions: - text: Get the query string sort setting for zone {zone}. slots: zone: path.zone_id - text: Check if query strings are sorted before caching. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/sort_query_string_for_cache'].patch update: x-apievangelist-phrasing: intent: Turn query string sort for cache on or off effect: write questions: - Can I improve cache hits by sorting query parameters before caching? - How do I stop sorting query strings for the cache key? instructions: - text: Set query string sort to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn cache query string sorting {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ssl'].get update: x-apievangelist-phrasing: intent: Get the SSL/TLS encryption mode effect: read questions: - Is my zone using Flexible, Full or Full (strict) SSL? - What SSL mode is set between visitors, the edge and my origin? instructions: - text: Get the SSL setting for zone {zone}. slots: zone: path.zone_id - text: Show my site's SSL encryption mode. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ssl'].patch update: x-apievangelist-phrasing: intent: Change the SSL/TLS encryption mode effect: write questions: - Can I switch my zone to Full (strict) SSL? - How do I change the SSL mode used to connect to my origin? instructions: - text: Set SSL mode to {mode} on zone {zone}. slots: mode: requestBody.value zone: path.zone_id - text: Change my site's encryption mode to {mode}. slots: mode: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ssl_recommender'].get update: x-apievangelist-phrasing: intent: Get SSL/TLS Recommender enrollment effect: read questions: - Is my zone enrolled in the SSL/TLS Recommender emails? - Am I receiving recommendations for a stronger SSL mode? instructions: - text: Get the SSL/TLS Recommender enrollment for zone {zone}. slots: zone: path.zone_id - text: Check whether SSL recommendations are enabled. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/ssl_recommender'].patch update: x-apievangelist-phrasing: intent: Enroll or unenroll in SSL/TLS Recommender effect: write questions: - Can I sign up to get periodic emails recommending a better SSL mode? - How do I stop SSL/TLS Recommender emails? instructions: - text: Set SSL/TLS Recommender enrollment on zone {zone} to {value}. slots: zone: path.zone_id value: requestBody.value - text: Turn SSL mode recommendation emails {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/tls_1_3'].get update: x-apievangelist-phrasing: intent: Get the TLS 1.3 setting effect: read questions: - Is TLS 1.3 enabled for my zone? - What is the TLS 1.3 value, including zero round-trip mode? instructions: - text: Get the TLS 1.3 setting for zone {zone}. slots: zone: path.zone_id - text: Check whether visitors can negotiate TLS 1.3. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/tls_1_3'].patch update: x-apievangelist-phrasing: intent: Change the TLS 1.3 setting effect: write questions: - Can I enable TLS 1.3 for faster, more secure handshakes? - How do I turn TLS 1.3 off on a zone? instructions: - text: Set TLS 1.3 to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn TLS 1.3 support {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/tls_client_auth'].get update: x-apievangelist-phrasing: intent: Get the TLS Client Auth setting effect: read questions: - Is the edge presenting a client certificate when connecting to my origin? - What is the TLS Client Auth value for this Enterprise zone? instructions: - text: Get the TLS Client Auth setting for zone {zone}. slots: zone: path.zone_id - text: Check whether origin connections use a client certificate. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/tls_client_auth'].patch update: x-apievangelist-phrasing: intent: Turn TLS Client Auth on or off effect: write questions: - Can I require a client certificate on connections from the edge to my origin? - What disables the TLS Client Auth setting? instructions: - text: Set TLS Client Auth to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn client-certificate origin connections {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/true_client_ip_header'].get update: x-apievangelist-phrasing: intent: Get the True-Client-IP header setting effect: read questions: - Is the True-Client-IP header being sent to my origin? - What is the True Client IP value on this zone? instructions: - text: Get the True Client IP setting for zone {zone}. slots: zone: path.zone_id - text: Check whether my origin gets a True-Client-IP header. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/true_client_ip_header'].patch update: x-apievangelist-phrasing: intent: Turn the True-Client-IP header on or off effect: write questions: - Can I keep receiving the visitor IP in a True-Client-IP header at my origin? - What stops the True-Client-IP header? instructions: - text: Set True Client IP header to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn the True-Client-IP origin header {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/waf'].get update: x-apievangelist-phrasing: intent: Get the WAF setting effect: read questions: - Is the web application firewall inspecting requests on my zone? - What is the WAF value for this site? instructions: - text: Get the Web Application Firewall setting for zone {zone}. slots: zone: path.zone_id - text: Check whether the WAF is on. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/waf'].patch update: x-apievangelist-phrasing: intent: Turn the WAF on or off effect: write questions: - Can I enable the web application firewall to inspect GET and POST requests? - How do I switch off the WAF for my zone? instructions: - text: Set the Web Application Firewall to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn the WAF {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/webp'].get update: x-apievangelist-phrasing: intent: Get the WebP image conversion setting effect: read questions: - Are images being served as WebP to browsers that support it? - Is WebP conversion enabled on this zone? instructions: - text: Get the WebP setting for zone {zone}. slots: zone: path.zone_id - text: Check whether WebP images are served. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/webp'].patch update: x-apievangelist-phrasing: intent: Turn WebP image conversion on or off effect: write questions: - Can I serve WebP images to supporting browsers when they're smaller? - What turns off WebP conversion? instructions: - text: Set WebP to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn WebP image delivery {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/websockets'].get update: x-apievangelist-phrasing: intent: Get the WebSockets setting effect: read questions: - Are WebSocket connections allowed through to my origin? - Is WebSockets support on for this zone? instructions: - text: Get the WebSockets setting for zone {zone}. slots: zone: path.zone_id - text: Check whether WebSocket connections are enabled. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/websockets'].patch update: x-apievangelist-phrasing: intent: Turn WebSockets on or off effect: write questions: - Can I allow WebSocket connections to my app? - How do I disable WebSockets on a zone? instructions: - text: Set WebSockets to {value} on zone {zone}. slots: value: requestBody.value zone: path.zone_id - text: Turn WebSocket support {value}. slots: value: requestBody.value method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/config'].get update: x-apievangelist-phrasing: intent: Get the latest Zaraz configuration effect: read questions: - What third-party tools and triggers are in my zone's current Zaraz configuration? - Does the Zaraz config I get back reflect the preview or the published version? instructions: - text: Get the latest Zaraz configuration for zone {zone}. slots: zone: path.zone_id - text: Show my most recently updated Zaraz setup. method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/config'].put update: x-apievangelist-phrasing: intent: Update a zone's Zaraz configuration effect: write questions: - How do I change the Zaraz tools, triggers and variables configured on my site? - Can I turn on the Zaraz data layer and set a debug key for a zone? - What fields does a full Zaraz configuration update require? instructions: - text: Replace the Zaraz configuration on zone {zone_id} with my edited triggers and variables. slots: zone_id: path.zone_id - text: Set the Zaraz debug key to {debugKey} in the configuration for zone {zone_id}. slots: debugKey: requestBody.debugKey zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/default'].get update: x-apievangelist-phrasing: intent: Get the default Zaraz configuration effect: read questions: - What does an out-of-the-box Zaraz configuration look like for my zone? - Can I see the factory default Zaraz settings before I customize them? instructions: - text: Show me the default Zaraz configuration template for zone {zone_id}. slots: zone_id: path.zone_id - text: Fetch the baseline Zaraz defaults for zone {zone_id} so I can compare with my setup. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/export'].get update: x-apievangelist-phrasing: intent: Export the published Zaraz configuration effect: read questions: - Can I download my live Zaraz configuration including secret variables? - Is there a way to back up the currently published Zaraz setup for a zone? instructions: - text: Export the full published Zaraz configuration for zone {zone_id}, secrets included. slots: zone_id: path.zone_id - text: Back up the live Zaraz config of zone {zone_id} to a file. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/history'].get update: x-apievangelist-phrasing: intent: List past published Zaraz configurations effect: read questions: - Where can I see a log of every Zaraz configuration I've published? - Can I page through Zaraz config history sorted by date? instructions: - text: List the Zaraz publish history for zone {zone_id}, newest first. slots: zone_id: path.zone_id - text: Show {limit} historical Zaraz config records for zone {zone_id}. slots: limit: query.limit zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/history'].put update: x-apievangelist-phrasing: intent: Restore an earlier Zaraz configuration effect: write questions: - Can I roll Zaraz back to a configuration I published last week? - How do I restore an older published Zaraz version by its ID? instructions: - text: Roll back Zaraz on zone {zone_id} to a previously published configuration. slots: zone_id: path.zone_id - text: Restore the historical Zaraz config record I pick for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/history/configs'].get update: x-apievangelist-phrasing: intent: Get specific historical Zaraz configs by ID effect: read questions: - Can I pull the full contents of particular old Zaraz configurations by their IDs? - What did my Zaraz config contain in a given historical record? instructions: - text: Fetch the Zaraz historical configurations with IDs {ids} on zone {zone_id}. slots: ids: query.ids zone_id: path.zone_id - text: Show the saved Zaraz config body for record {ids} so I can diff it. slots: ids: query.ids method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/publish'].post update: x-apievangelist-phrasing: intent: Publish the Zaraz preview configuration effect: write questions: - How do I push my Zaraz preview changes live? - Can I promote the Zaraz preview config to production for a zone? instructions: - text: Publish the current Zaraz preview configuration on zone {zone_id}. slots: zone_id: path.zone_id - text: Make my staged Zaraz changes live for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/workflow'].get update: x-apievangelist-phrasing: intent: Get the Zaraz workflow mode effect: read questions: - Is my zone's Zaraz set to publish changes directly or through a preview step? - Which Zaraz workflow is active on this zone? instructions: - text: Tell me which Zaraz workflow zone {zone_id} uses. slots: zone_id: path.zone_id - text: Check the Zaraz workflow setting for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/settings/zaraz/workflow'].put update: x-apievangelist-phrasing: intent: Change the Zaraz workflow mode effect: write questions: - Can I switch how Zaraz changes go live on my zone? - How do I change the Zaraz workflow for a zone? instructions: - text: Switch the Zaraz workflow on zone {zone_id} to the mode I choose. slots: zone_id: path.zone_id - text: Update the Zaraz workflow mode for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/availabilities'].get update: x-apievangelist-phrasing: intent: Get page speed test quota and availability effect: read questions: - How many page speed tests do I have left on my plan? - What test quotas does each plan get for page speed testing? instructions: - text: Show the speed test quota remaining for zone {zone_id}. slots: zone_id: path.zone_id - text: Check speed testing availability and plan quotas for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/pages'].get update: x-apievangelist-phrasing: intent: List webpages that have been speed tested effect: read questions: - Which of my pages have already been run through a speed test? - Can I see every URL tested for performance on this zone? instructions: - text: List all tested webpages on zone {zone_id}. slots: zone_id: path.zone_id - text: Show me which pages of zone {zone_id} have speed test results. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/pages/{url}/tests'].get update: x-apievangelist-phrasing: intent: List the speed test history for a page effect: read questions: - What past performance tests have run against a particular page? - Can I filter a page's test history by region? instructions: - text: List previous speed tests for page {url} on zone {zone_id}. slots: url: path.url zone_id: path.zone_id - text: Show the test history for {url} run from region {region}. slots: url: path.url region: query.region method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/pages/{url}/tests'].post update: x-apievangelist-phrasing: intent: Start a speed test for a page effect: write questions: - How do I run a new performance test on one of my pages? - Can I choose which region a page speed test runs from? instructions: - text: Run a speed test on {url} for zone {zone_id}. slots: url: path.url zone_id: path.zone_id - text: Start a page test of {url} from region {region}. slots: url: path.url region: requestBody.region method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/pages/{url}/tests'].delete update: x-apievangelist-phrasing: intent: Delete all speed tests for a page effect: destructive questions: - Can I wipe all speed test results for a page in one region? - Do deleted page tests still count against my test quota? instructions: - text: Delete every speed test for page {url} on zone {zone_id}. slots: url: path.url zone_id: path.zone_id - text: Clear the {region} test results for {url}. slots: region: query.region url: path.url method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}'].get update: x-apievangelist-phrasing: intent: Get the result of one page speed test effect: read questions: - What were the results of a specific speed test I ran? - Can I look up a single page test by its test ID? instructions: - text: Get the result of test {test_id} for page {url} on zone {zone_id}. slots: test_id: path.test_id url: path.url zone_id: path.zone_id - text: Show me the scores from speed test {test_id}. slots: test_id: path.test_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/pages/{url}/trend'].get update: x-apievangelist-phrasing: intent: Show a page's Core Web Vitals trend effect: read questions: - How have a page's Core Web Vitals changed over time? - Can I chart web vital metrics for a page on mobile versus desktop? instructions: - text: Show the {metrics} trend for {url} on {deviceType} in {region} since {start}, timezone {tz}. slots: metrics: query.metrics url: path.url deviceType: query.deviceType region: query.region start: query.start tz: query.tz - text: Chart web vitals for page {url} on zone {zone_id} over the last month. slots: url: path.url zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/schedule/{url}'].get update: x-apievangelist-phrasing: intent: Get a page's scheduled test settings effect: read questions: - Is there a recurring speed test scheduled for this page? - What region and frequency is a page's test schedule set to? instructions: - text: Show the test schedule for {url} on zone {zone_id}. slots: url: path.url zone_id: path.zone_id - text: Check whether {url} has a scheduled test in region {region}. slots: url: path.url region: query.region method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/schedule/{url}'].post update: x-apievangelist-phrasing: intent: Schedule recurring speed tests for a page effect: write questions: - Can I have a page tested automatically on a schedule? - How do I set up recurring performance monitoring for a URL? instructions: - text: Create a scheduled speed test for {url} on zone {zone_id}. slots: url: path.url zone_id: path.zone_id - text: Schedule automatic tests of {url} from region {region}. slots: url: path.url region: query.region method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/speed_api/schedule/{url}'].delete update: x-apievangelist-phrasing: intent: Remove a page's scheduled speed test effect: destructive questions: - Can I stop the recurring speed tests on a page? - What happens if I remove a page's test schedule? instructions: - text: Delete the scheduled test for {url} on zone {zone_id}. slots: url: path.url zone_id: path.zone_id - text: Stop automatic testing of {url} in region {region}. slots: url: path.url region: query.region method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/analyze'].post update: x-apievangelist-phrasing: intent: Analyze a certificate before uploading effect: read questions: - Which hostnames and expiration date does this certificate cover? - Can I check a certificate's signature algorithm before I upload it? instructions: - text: Analyze this certificate {certificate} for zone {zone_id}. slots: certificate: requestBody.certificate zone_id: path.zone_id - text: Inspect my certificate using bundle method {bundle_method} and report its expiry. slots: bundle_method: requestBody.bundle_method method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/certificate_packs'].get update: x-apievangelist-phrasing: intent: List a zone's certificate packs effect: read questions: - What certificate packs are active on my zone? - Can I list certificate packs filtered by status? instructions: - text: List active certificate packs for zone {zone_id}. slots: zone_id: path.zone_id - text: Show certificate packs on zone {zone_id} with status {status}. slots: zone_id: path.zone_id status: query.status method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}'].get update: x-apievangelist-phrasing: intent: Get details of a certificate pack effect: read questions: - What hosts and status does a specific certificate pack have? - Can I look up one certificate pack by its ID? instructions: - text: Get certificate pack {certificate_pack_id} on zone {zone_id}. slots: certificate_pack_id: path.certificate_pack_id zone_id: path.zone_id - text: Show the details of cert pack {certificate_pack_id}. slots: certificate_pack_id: path.certificate_pack_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}'].delete update: x-apievangelist-phrasing: intent: Delete an advanced certificate pack effect: destructive questions: - Can I remove an Advanced Certificate Manager pack I no longer need? - What happens to my hosts when I delete an advanced certificate pack? instructions: - text: Delete advanced certificate pack {certificate_pack_id} from zone {zone_id}. slots: certificate_pack_id: path.certificate_pack_id zone_id: path.zone_id - text: Remove the ACM certificate pack {certificate_pack_id}. slots: certificate_pack_id: path.certificate_pack_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}'].patch update: x-apievangelist-phrasing: intent: Restart validation for a timed-out certificate pack effect: write questions: - My advanced certificate pack's validation timed out, can I retry it? - How do I restart validation on a certificate pack stuck in validation_timed_out? instructions: - text: Restart validation for certificate pack {certificate_pack_id} on zone {zone_id}. slots: certificate_pack_id: path.certificate_pack_id zone_id: path.zone_id - text: Retry the timed-out validation of cert pack {certificate_pack_id}. slots: certificate_pack_id: path.certificate_pack_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/certificate_packs/order'].post update: x-apievangelist-phrasing: intent: Order an advanced certificate pack effect: write questions: - How do I buy an advanced certificate covering several hostnames? - Can I choose the certificate authority and validity period when ordering a certificate pack? instructions: - text: Order an advanced certificate pack for {hosts} from {certificate_authority}, valid {validity_days} days, using {validation_method} validation, type {type}. slots: hosts: requestBody.hosts certificate_authority: requestBody.certificate_authority validity_days: requestBody.validity_days validation_method: requestBody.validation_method type: requestBody.type - text: Buy a new ACM certificate pack for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/certificate_packs/quota'].get update: x-apievangelist-phrasing: intent: Get certificate pack quotas effect: read questions: - How many more advanced certificate packs can I order on this zone? - What is my certificate pack quota? instructions: - text: Show certificate pack quotas for zone {zone_id}. slots: zone_id: path.zone_id - text: Check how many cert packs zone {zone_id} is allowed. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/universal/settings'].get update: x-apievangelist-phrasing: intent: Get Universal SSL settings effect: read questions: - Is Universal SSL enabled on my zone? - What are the current Universal SSL settings for a domain? instructions: - text: Show the Universal SSL settings for zone {zone_id}. slots: zone_id: path.zone_id - text: Check whether zone {zone_id} has Universal SSL turned on. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/universal/settings'].patch update: x-apievangelist-phrasing: intent: Enable or disable Universal SSL effect: write questions: - Can I turn off the free Universal SSL certificate for my zone? - How do I re-enable Universal SSL on a domain? instructions: - text: Set Universal SSL enabled to {enabled} on zone {zone_id}. slots: enabled: requestBody.enabled zone_id: path.zone_id - text: Disable Universal SSL for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/verification'].get update: x-apievangelist-phrasing: intent: Get SSL verification status for a zone effect: read questions: - Why isn't my SSL certificate verified yet? - Can I trigger a retry while checking a zone's SSL verification info? instructions: - text: Show SSL verification details for zone {zone_id}. slots: zone_id: path.zone_id - text: Check SSL verification for zone {zone_id} and retry with {retry}. slots: zone_id: path.zone_id retry: query.retry method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/ssl/verification/{certificate_pack_id}'].patch update: x-apievangelist-phrasing: intent: Change a certificate pack's validation method effect: write questions: - Can I switch the domain validation method on a certificate pack? - Does changing the validation method trigger an immediate validation check? instructions: - text: Change validation for cert pack {certificate_pack_id} on zone {zone_id} to {validation_method}. slots: certificate_pack_id: path.certificate_pack_id zone_id: path.zone_id validation_method: requestBody.validation_method - text: Use {validation_method} validation for certificate pack {certificate_pack_id} and check it now. slots: validation_method: requestBody.validation_method certificate_pack_id: path.certificate_pack_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/url_normalization'].get update: x-apievangelist-phrasing: intent: Get URL normalization settings effect: read questions: - How are incoming URLs normalized on my zone? - What scope and type of URL normalization is set? instructions: - text: Show the URL normalization settings for zone {zone_id}. slots: zone_id: path.zone_id - text: Tell me how zone {zone_id} normalizes request URLs. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/url_normalization'].put update: x-apievangelist-phrasing: intent: Update URL normalization settings effect: write questions: - Can I apply URL normalization to both incoming requests and origin requests? - How do I change the URL normalization type for a zone? instructions: - text: Set URL normalization on zone {zone_id} to type {type} with scope {scope}. slots: zone_id: path.zone_id type: requestBody.type scope: requestBody.scope - text: Change the URL normalization scope to {scope}. slots: scope: requestBody.scope method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/filters'].get update: x-apievangelist-phrasing: intent: List legacy Worker filters effect: read questions: - Which URL patterns have deprecated Worker filters on my zone? - Can I still see the old-style Worker filters? instructions: - text: List the deprecated Worker filters on zone {zone_id}. slots: zone_id: path.zone_id - text: Show legacy Worker filter patterns for zone {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/filters'].post update: x-apievangelist-phrasing: intent: Create a legacy Worker filter effect: write questions: - Can I add a deprecated-style Worker filter for a URL pattern? - What's needed to create an old Worker filter? instructions: - text: Create a legacy Worker filter for pattern {pattern} with enabled {enabled} on zone {zone_id}. slots: pattern: requestBody.pattern enabled: requestBody.enabled zone_id: path.zone_id - text: Add an enabled deprecated Worker filter matching {pattern}. slots: pattern: requestBody.pattern method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/filters/{filter_id}'].put update: x-apievangelist-phrasing: intent: Update a legacy Worker filter effect: write questions: - Can I change the pattern on an existing deprecated Worker filter? - How do I disable one legacy Worker filter? instructions: - text: Change legacy Worker filter {filter_id} on zone {zone_id} to pattern {pattern}, enabled {enabled}. slots: filter_id: path.filter_id zone_id: path.zone_id pattern: requestBody.pattern enabled: requestBody.enabled - text: Turn off the deprecated Worker filter {filter_id}. slots: filter_id: path.filter_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/filters/{filter_id}'].delete update: x-apievangelist-phrasing: intent: Delete a legacy Worker filter effect: destructive questions: - Can I remove an old deprecated Worker filter? - What's the way to clean up legacy Worker filters one at a time? instructions: - text: Delete legacy Worker filter {filter_id} from zone {zone_id}. slots: filter_id: path.filter_id zone_id: path.zone_id - text: Remove the deprecated filter {filter_id}. slots: filter_id: path.filter_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/routes'].get update: x-apievangelist-phrasing: intent: List Worker routes on a zone effect: read questions: - Which URL patterns on my zone are routed to Workers? - What Worker routes are configured for a domain? instructions: - text: List all Worker routes for zone {zone_id}. slots: zone_id: path.zone_id - text: Show which Workers each route on zone {zone_id} points to. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/routes'].post update: x-apievangelist-phrasing: intent: Route a URL pattern to a Worker effect: write questions: - How do I make a Worker run on a path of my site? - Can I map a URL pattern to a Worker script? instructions: - text: Create a route sending {pattern} to Worker {script} on zone {zone_id}. slots: pattern: requestBody.pattern script: requestBody.script zone_id: path.zone_id - text: Add a Worker route for {pattern}. slots: pattern: requestBody.pattern method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/routes/{route_id}'].get update: x-apievangelist-phrasing: intent: Get a Worker route effect: read questions: - What pattern and Worker does a specific route use? - Can I look up a single Worker route by ID? instructions: - text: Get Worker route {route_id} on zone {zone_id}. slots: route_id: path.route_id zone_id: path.zone_id - text: Show which Worker route {route_id} is bound to. slots: route_id: path.route_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/routes/{route_id}'].put update: x-apievangelist-phrasing: intent: Change a Worker route's pattern or script effect: write questions: - Can I point an existing route at a different Worker? - How do I change the URL pattern of a Worker route? instructions: - text: Update route {route_id} on zone {zone_id} to pattern {pattern} and Worker {script}. slots: route_id: path.route_id zone_id: path.zone_id pattern: requestBody.pattern script: requestBody.script - text: Repoint Worker route {route_id} to match {pattern}. slots: route_id: path.route_id pattern: requestBody.pattern method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/routes/{route_id}'].delete update: x-apievangelist-phrasing: intent: Delete a Worker route effect: destructive questions: - Can I stop a Worker from running on a URL pattern? - What happens to traffic after I delete a Worker route? instructions: - text: Delete Worker route {route_id} from zone {zone_id}. slots: route_id: path.route_id zone_id: path.zone_id - text: Remove route {route_id} so its Worker no longer runs. slots: route_id: path.route_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/script'].get update: x-apievangelist-phrasing: intent: Download a zone's legacy Worker script effect: read questions: - Can I get the raw source of the old zone-level Worker? - Where do I download my deprecated single-script Worker code? instructions: - text: Download the legacy Worker script for zone {zone_id}. slots: zone_id: path.zone_id - text: Fetch the raw source of the deprecated zone Worker on {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/script'].put update: x-apievangelist-phrasing: intent: Upload a legacy zone Worker script effect: write questions: - Can I upload a new version of my deprecated zone-level Worker? - How do I deploy code to the old single Worker on a zone? instructions: - text: Upload a new version of the legacy Worker on zone {zone_id}. slots: zone_id: path.zone_id - text: Deploy this script as the deprecated zone Worker for {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/script'].delete update: x-apievangelist-phrasing: intent: Delete a legacy zone Worker script effect: destructive questions: - Can I remove the deprecated Worker attached to my zone? - Does deleting the old zone Worker return any response body? instructions: - text: Delete the legacy Worker script on zone {zone_id}. slots: zone_id: path.zone_id - text: Remove the deprecated zone-level Worker from {zone_id}. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_id}/workers/script/bindings'].get update: x-apievangelist-phrasing: intent: List bindings of a legacy zone Worker effect: read questions: - What bindings does my deprecated zone Worker script have? - Can I see which resources the old zone Worker is bound to? instructions: - text: List bindings for the legacy Worker on zone {zone_id}. slots: zone_id: path.zone_id - text: Show what the deprecated zone Worker on {zone_id} is bound to. slots: zone_id: path.zone_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/analytics/colos'].get update: x-apievangelist-phrasing: intent: Break down zone analytics by data center effect: read questions: - Which data centers are serving the most traffic for my zone? - Can Enterprise zones see analytics split by colocation? instructions: - text: Break down traffic for zone {zone_identifier} by data center since {since}. slots: zone_identifier: path.zone_identifier since: query.since - text: Show per-colo analytics for zone {zone_identifier} until {until}. slots: zone_identifier: path.zone_identifier until: query.until method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/analytics/dashboard'].get update: x-apievangelist-phrasing: intent: Get zone analytics dashboard totals effect: read questions: - What were my zone's total requests and bandwidth over the last day? - Can I get timeseries traffic data for a zone across the whole network? instructions: - text: Show the analytics dashboard for zone {zone_identifier} from {since} to {until}. slots: zone_identifier: path.zone_identifier since: query.since until: query.until - text: Get traffic totals and timeseries for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/available_plans'].get update: x-apievangelist-phrasing: intent: List plans a zone can subscribe to effect: read questions: - Which plans can I upgrade this zone to? - What subscription plans are available for my domain? instructions: - text: List available plans for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show upgrade plan options for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/available_plans/{plan_identifier}'].get update: x-apievangelist-phrasing: intent: Get details of an available plan effect: read questions: - What does a particular plan include and cost for my zone? - Can I see the details of one plan before subscribing? instructions: - text: Show details of plan {plan_identifier} for zone {zone_identifier}. slots: plan_identifier: path.plan_identifier zone_identifier: path.zone_identifier - text: Describe available plan {plan_identifier}. slots: plan_identifier: path.plan_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/available_rate_plans'].get update: x-apievangelist-phrasing: intent: List rate plans a zone can subscribe to effect: read questions: - What rate plans can this zone be put on? - Can I see all rate plans with their components for my zone? instructions: - text: List available rate plans for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show every rate plan zone {zone_identifier} is eligible for. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/custom_pages'].get update: x-apievangelist-phrasing: intent: List a zone's custom error pages effect: read questions: - Which custom error and challenge pages are set up on my zone? - Can I see all zone-level custom pages at once? instructions: - text: List custom pages for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show which custom pages zone {zone_identifier} has customized. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/custom_pages/{identifier}'].get update: x-apievangelist-phrasing: intent: Get a zone custom page effect: read questions: - What URL is a specific custom page pointing to? - Is a particular custom page on my zone customized or default? instructions: - text: Get custom page {identifier} on zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Show the configuration of custom page {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/custom_pages/{identifier}'].put update: x-apievangelist-phrasing: intent: Point a custom page at my own URL effect: write questions: - How do I replace the default error page with my own hosted page? - Can I revert a custom page back to the default state? instructions: - text: Set custom page {identifier} on zone {zone_identifier} to {url} with state {state}. slots: identifier: path.identifier zone_identifier: path.zone_identifier url: requestBody.url state: requestBody.state - text: Use {url} as my custom page for {identifier}. slots: url: requestBody.url identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing'].get update: x-apievangelist-phrasing: intent: Get Email Routing settings effect: read questions: - Is Email Routing enabled on my domain? - What is the current Email Routing status for a zone? instructions: - text: Show Email Routing settings for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Check whether Email Routing is on for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/disable'].post update: x-apievangelist-phrasing: intent: Disable Email Routing effect: destructive questions: - Can I turn off Email Routing and remove its MX records? - What happens to my MX records if I disable Email Routing? instructions: - text: Disable Email Routing on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Turn off email forwarding for zone {zone_identifier} and drop its extra MX records. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/dns'].get update: x-apievangelist-phrasing: intent: Show DNS records needed for Email Routing effect: read questions: - Which DNS records do I need to add for Email Routing to work? - What MX and SPF records does Email Routing expect? instructions: - text: Show the Email Routing DNS records required for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: List the MX and SPF entries zone {zone_identifier} needs for email forwarding. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/enable'].post update: x-apievangelist-phrasing: intent: Enable Email Routing effect: write questions: - How do I turn on Email Routing for my domain? - Does enabling Email Routing lock the MX and SPF records it adds? instructions: - text: Enable Email Routing on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Switch on email forwarding for zone {zone_identifier} and set up its MX records. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/rules'].get update: x-apievangelist-phrasing: intent: List email routing rules effect: read questions: - What email forwarding rules exist on my domain? - Can I list only the enabled email routing rules? instructions: - text: List email routing rules for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show routing rules on zone {zone_identifier} where enabled is {enabled}. slots: zone_identifier: path.zone_identifier enabled: query.enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/rules'].post update: x-apievangelist-phrasing: intent: Create an email forwarding rule effect: write questions: - How do I forward mail sent to a custom address to my inbox? - Can I set a priority when adding an email routing rule? instructions: - text: Create routing rule {name} on zone {zone_identifier} matching {matchers} with actions {actions}. slots: name: requestBody.name zone_identifier: path.zone_identifier matchers: requestBody.matchers actions: requestBody.actions - text: Add a new email rule that matches {matchers} and forwards via {actions}. slots: matchers: requestBody.matchers actions: requestBody.actions method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/rules/{rule_identifier}'].get update: x-apievangelist-phrasing: intent: Get an email routing rule effect: read questions: - Where does a particular email routing rule forward messages? - Can I look up one routing rule by its ID? instructions: - text: Get email routing rule {rule_identifier} on zone {zone_identifier}. slots: rule_identifier: path.rule_identifier zone_identifier: path.zone_identifier - text: Show the matchers and actions of routing rule {rule_identifier}. slots: rule_identifier: path.rule_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/rules/{rule_identifier}'].put update: x-apievangelist-phrasing: intent: Update an email routing rule effect: write questions: - Can I change where an existing email rule forwards to? - How do I disable one email routing rule without deleting it? instructions: - text: Update routing rule {rule_identifier} on zone {zone_identifier} to match {matchers} with actions {actions}. slots: rule_identifier: path.rule_identifier zone_identifier: path.zone_identifier matchers: requestBody.matchers actions: requestBody.actions - text: Set existing email rule {rule_identifier} enabled to {enabled}. slots: rule_identifier: path.rule_identifier enabled: requestBody.enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/rules/{rule_identifier}'].delete update: x-apievangelist-phrasing: intent: Delete an email routing rule effect: destructive questions: - Can I remove an email forwarding rule I no longer use? - What happens to mail after its routing rule is deleted? instructions: - text: Delete email routing rule {rule_identifier} from zone {zone_identifier}. slots: rule_identifier: path.rule_identifier zone_identifier: path.zone_identifier - text: Remove forwarding rule {rule_identifier}. slots: rule_identifier: path.rule_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/rules/catch_all'].get update: x-apievangelist-phrasing: intent: Get the catch-all email rule effect: read questions: - What happens to email sent to addresses with no matching rule? - Is the catch-all email rule turned on for my domain? instructions: - text: Show the catch-all email rule for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Check where unmatched email on zone {zone_identifier} goes. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/email/routing/rules/catch_all'].put update: x-apievangelist-phrasing: intent: Update the catch-all email rule effect: write questions: - Can I forward all unmatched email to one destination address? - How do I switch off the catch-all email rule? instructions: - text: Set the catch-all rule on zone {zone_identifier} to actions {actions} with matchers {matchers}. slots: zone_identifier: path.zone_identifier actions: requestBody.actions matchers: requestBody.matchers - text: Turn the catch-all email rule enabled to {enabled}. slots: enabled: requestBody.enabled method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/filters'].get update: x-apievangelist-phrasing: intent: List firewall filter expressions effect: read questions: - Which filter expressions are defined on my zone? - Can I search filters by expression text or show only paused ones? instructions: - text: List filters on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Find filters whose expression contains {expression}. slots: expression: query.expression method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/filters'].put update: x-apievangelist-phrasing: intent: Update several filters at once effect: write questions: - Can I edit multiple filter expressions in one request? - Is there a bulk way to change existing filters? instructions: - text: Bulk update these filters on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Apply my edits to several existing filters in zone {zone_identifier} at once. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/filters'].post update: x-apievangelist-phrasing: intent: Create filter expressions effect: write questions: - How do I define a new filter expression for firewall rules? - Can I create several filters in a single call? instructions: - text: Create new filters on zone {zone_identifier} from these expressions. slots: zone_identifier: path.zone_identifier - text: Add a filter expression to zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/filters'].delete update: x-apievangelist-phrasing: intent: Delete several filters at once effect: destructive questions: - Can I delete a batch of filters in one request? - Is there a bulk remove for filter expressions? instructions: - text: Delete filters {id} from zone {zone_identifier}. slots: id: requestBody.id zone_identifier: path.zone_identifier - text: Bulk remove the filters with IDs {id}. slots: id: requestBody.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/filters/{id}'].get update: x-apievangelist-phrasing: intent: Get a filter expression effect: read questions: - What expression does a particular filter contain? - Can I fetch one filter by its ID? instructions: - text: Get filter {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Show the expression of filter {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/filters/{id}'].put update: x-apievangelist-phrasing: intent: Update one filter expression effect: write questions: - Can I change the expression of a single filter? - How do I pause just one filter? instructions: - text: Update filter {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Edit the expression of the single filter {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/filters/{id}'].delete update: x-apievangelist-phrasing: intent: Delete one filter effect: destructive questions: - Can I remove a single unused filter? - What happens if I delete a filter used by a firewall rule? instructions: - text: Delete filter {id} from zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Remove the one filter {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/lockdowns'].get update: x-apievangelist-phrasing: intent: List Zone Lockdown rules effect: read questions: - Which URLs are locked down to specific IPs on my zone? - Can I search lockdown rules by IP address or URI? instructions: - text: List Zone Lockdown rules for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Find lockdown rules that allow IP {ip_search}. slots: ip_search: query.ip_search - text: Show lockdown rules covering URI {uri_search}. slots: uri_search: query.uri_search method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/lockdowns'].post update: x-apievangelist-phrasing: intent: Create a Zone Lockdown rule effect: write questions: - How do I restrict an admin URL to only my office IPs? - Can I lock down a path so only allowed addresses reach it? instructions: - text: Create a Zone Lockdown rule on zone {zone_identifier} allowing only my IPs to a URL. slots: zone_identifier: path.zone_identifier - text: Lock down my admin path on zone {zone_identifier} to our office network. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/lockdowns/{id}'].get update: x-apievangelist-phrasing: intent: Get a Zone Lockdown rule effect: read questions: - What URLs and IPs does a specific lockdown rule cover? - Can I look up a lockdown rule by ID? instructions: - text: Get Zone Lockdown rule {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Show the allowed IPs of lockdown rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/lockdowns/{id}'].put update: x-apievangelist-phrasing: intent: Update a Zone Lockdown rule effect: write questions: - Can I add another IP to an existing lockdown rule? - How do I change which URLs a lockdown rule protects? instructions: - text: Update Zone Lockdown rule {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Add my new office IP to lockdown rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/lockdowns/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a Zone Lockdown rule effect: destructive questions: - Can I remove an IP lockdown from a URL? - What happens to access once a lockdown rule is deleted? instructions: - text: Delete Zone Lockdown rule {id} from zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Remove lockdown rule {id} so the URL is open again. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules'].get update: x-apievangelist-phrasing: intent: List firewall rules effect: read questions: - What firewall rules are active on my zone? - Can I list only firewall rules that block, or only paused ones? instructions: - text: List firewall rules on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show firewall rules with action {action}. slots: action: query.action method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules'].put update: x-apievangelist-phrasing: intent: Update several firewall rules at once effect: write questions: - Can I edit a batch of firewall rules in one request? - Is there a bulk update for existing firewall rules? instructions: - text: Bulk update these firewall rules on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Apply my changes to multiple firewall rules in zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules'].post update: x-apievangelist-phrasing: intent: Create firewall rules effect: write questions: - How do I block traffic that matches a filter? - Can I create several firewall rules together? instructions: - text: Create firewall rules on zone {zone_identifier} using my filters. slots: zone_identifier: path.zone_identifier - text: Add a new firewall rule to zone {zone_identifier} that challenges matching requests. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules'].delete update: x-apievangelist-phrasing: intent: Delete several firewall rules effect: destructive questions: - Can I delete many firewall rules in one go? - Is there a bulk delete for firewall rules? instructions: - text: Delete firewall rules {id} from zone {zone_identifier}. slots: id: requestBody.id zone_identifier: path.zone_identifier - text: Bulk remove firewall rules with IDs {id}. slots: id: requestBody.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules'].patch update: x-apievangelist-phrasing: intent: Reorder the priority of firewall rules effect: write questions: - Can I change the evaluation order of several firewall rules? - How do I reprioritize my firewall rules in bulk? instructions: - text: Reorder firewall rule priorities on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Set new priorities for multiple firewall rules in zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules/{id}'].get update: x-apievangelist-phrasing: intent: Get a firewall rule effect: read questions: - What action and filter does a specific firewall rule use? - Can I look up a firewall rule by its ID? instructions: - text: Get firewall rule {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Show the details of firewall rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules/{id}'].put update: x-apievangelist-phrasing: intent: Update one firewall rule effect: write questions: - Can I change the action on a single firewall rule? - How do I pause just one firewall rule? instructions: - text: Update firewall rule {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Change the action on just firewall rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules/{id}'].delete update: x-apievangelist-phrasing: intent: Delete one firewall rule effect: destructive questions: - Can I delete one firewall rule and its filter too if unused? - What happens to the filter when I remove a firewall rule? instructions: - text: Delete firewall rule {id} from zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: 'Remove firewall rule {id} and delete its filter if unused: {delete_filter_if_unused}.' slots: id: path.id delete_filter_if_unused: requestBody.delete_filter_if_unused method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/rules/{id}'].patch update: x-apievangelist-phrasing: intent: Change one firewall rule's priority effect: write questions: - Can I move a single firewall rule higher in evaluation order? - How do I change the priority of just one firewall rule? instructions: - text: Change the priority of firewall rule {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Move firewall rule {id} to run earlier. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/ua_rules'].get update: x-apievangelist-phrasing: intent: List User Agent Blocking rules effect: read questions: - Which user agents am I blocking on my zone? - Can I search blocking rules by user agent string? instructions: - text: List User Agent Blocking rules for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Find UA blocking rules matching user agent {ua_search}. slots: ua_search: query.ua_search method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/ua_rules'].post update: x-apievangelist-phrasing: intent: Block a user agent effect: write questions: - How do I block a specific bot by its user agent? - Can I challenge requests from a certain user agent string? instructions: - text: Create a User Agent Blocking rule on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Block this scraper's user agent on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/ua_rules/{id}'].get update: x-apievangelist-phrasing: intent: Get a User Agent Blocking rule effect: read questions: - What user agent and action does a specific blocking rule use? - Can I look up a UA blocking rule by ID? instructions: - text: Get User Agent Blocking rule {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Show the user agent targeted by rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/ua_rules/{id}'].put update: x-apievangelist-phrasing: intent: Update a User Agent Blocking rule effect: write questions: - Can I change the action on a user agent blocking rule? - How do I pause a UA blocking rule? instructions: - text: Update User Agent Blocking rule {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Change the mode or user agent of UA rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/ua_rules/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a User Agent Blocking rule effect: destructive questions: - Can I unblock a user agent I blocked earlier? - What happens once a UA blocking rule is removed? instructions: - text: Delete User Agent Blocking rule {id} from zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Unblock the user agent in rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/overrides'].get update: x-apievangelist-phrasing: intent: List URI-based WAF overrides effect: read questions: - Which URLs have WAF overrides under the previous managed rules? - Can I page through legacy WAF overrides on my zone? instructions: - text: List WAF overrides for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show the URI-based WAF overrides on zone {zone_identifier}, {per_page} per page. slots: zone_identifier: path.zone_identifier per_page: query.per_page method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/overrides'].post update: x-apievangelist-phrasing: intent: Create a URI-based WAF override effect: write questions: - How do I relax legacy WAF rules for one URL? - Can I override previous-version WAF behavior for a specific path? instructions: - text: Create a WAF override on zone {zone_identifier} for my API path. slots: zone_identifier: path.zone_identifier - text: Add a URI-based WAF override to zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/overrides/{id}'].get update: x-apievangelist-phrasing: intent: Get a URI-based WAF override effect: read questions: - What URLs and rules does a specific WAF override change? - Can I fetch one WAF override by its ID? instructions: - text: Get WAF override {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Show the URLs covered by WAF override {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/overrides/{id}'].put update: x-apievangelist-phrasing: intent: Update a URI-based WAF override effect: write questions: - Can I change the URLs an existing WAF override applies to? - How do I edit the rule actions in a WAF override? instructions: - text: Update WAF override {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Edit the URL list of WAF override {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/overrides/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a URI-based WAF override effect: destructive questions: - Can I remove a WAF override so default protection applies again? - What happens once a legacy WAF override is deleted? instructions: - text: Delete WAF override {id} from zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Remove override {id} and restore normal WAF behavior. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/packages'].get update: x-apievangelist-phrasing: intent: List WAF rule packages effect: read questions: - Which legacy WAF packages are available on my zone? - Can I search WAF packages by name? instructions: - text: List WAF packages for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Find WAF packages named {name}. slots: name: query.name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/packages/{identifier}'].get update: x-apievangelist-phrasing: intent: Get a WAF rule package effect: read questions: - What sensitivity and action mode is a WAF package using? - Can I look up one WAF package by ID? instructions: - text: Get WAF package {identifier} on zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Show the settings of WAF package {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/firewall/waf/packages/{identifier}'].patch update: x-apievangelist-phrasing: intent: Set a WAF package's sensitivity and action effect: write questions: - Can I lower the sensitivity of an anomaly detection WAF package? - How do I change the default action of a WAF package? instructions: - text: Set WAF package {identifier} on zone {zone_identifier} to sensitivity {sensitivity}. slots: identifier: path.identifier zone_identifier: path.zone_identifier sensitivity: requestBody.sensitivity - text: Change the action mode of WAF package {identifier} to {action_mode}. slots: identifier: path.identifier action_mode: requestBody.action_mode method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks'].get update: x-apievangelist-phrasing: intent: List health checks effect: read questions: - Which origin health checks are configured on my zone? - Can I see all my standalone health checks? instructions: - text: List health checks for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show every configured health check on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks'].post update: x-apievangelist-phrasing: intent: Create a health check for an origin effect: write questions: - How do I monitor whether my origin server is up? - Can I set how many consecutive failures mark an origin unhealthy? instructions: - text: Create health check {name} on zone {zone_identifier} for address {address}. slots: name: requestBody.name zone_identifier: path.zone_identifier address: requestBody.address - text: Start monitoring {address} every {interval} seconds as check {name}. slots: address: requestBody.address interval: requestBody.interval name: requestBody.name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks/{identifier}'].get update: x-apievangelist-phrasing: intent: Get a health check effect: read questions: - What is the current configuration of a specific health check? - Is a particular health check reporting my origin healthy? instructions: - text: Get health check {identifier} on zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Show the status of health check {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks/{identifier}'].put update: x-apievangelist-phrasing: intent: Replace a health check's configuration effect: write questions: - Can I fully redefine an existing health check? - How do I overwrite every setting on a health check? instructions: - text: Replace health check {identifier} on zone {zone_identifier} with name {name} and address {address}. slots: identifier: path.identifier zone_identifier: path.zone_identifier name: requestBody.name address: requestBody.address - text: Overwrite the full config of health check {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks/{identifier}'].delete update: x-apievangelist-phrasing: intent: Delete a health check effect: destructive questions: - Can I stop monitoring an origin I've retired? - What happens to alerts once a health check is deleted? instructions: - text: Delete health check {identifier} from zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Remove the monitor {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks/{identifier}'].patch update: x-apievangelist-phrasing: intent: Patch selected fields of a health check effect: write questions: - Can I suspend a health check without redefining it? - Is it possible to change just the timeout on a health check? instructions: - text: Patch health check {identifier} on zone {zone_identifier} to suspended {suspended}. slots: identifier: path.identifier zone_identifier: path.zone_identifier suspended: requestBody.suspended - text: Tweak only the timeout of health check {identifier} to {timeout}. slots: identifier: path.identifier timeout: requestBody.timeout method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks/preview'].post update: x-apievangelist-phrasing: intent: Create a preview health check effect: write questions: - Can I trial a health check configuration before saving it? - How do I preview a health check against an origin? instructions: - text: Create a preview health check {name} for {address} on zone {zone_identifier}. slots: name: requestBody.name address: requestBody.address zone_identifier: path.zone_identifier - text: Trial-run a check against origin {address}. slots: address: requestBody.address method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks/preview/{identifier}'].get update: x-apievangelist-phrasing: intent: Get a preview health check's results effect: read questions: - What did my preview health check find? - Can I see the results of a trial health check? instructions: - text: Get preview health check {identifier} on zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Show results of the trial check {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/healthchecks/preview/{identifier}'].delete update: x-apievangelist-phrasing: intent: Delete a preview health check effect: destructive questions: - Can I discard a trial health check I no longer need? - Do preview health checks need to be cleaned up? instructions: - text: Delete preview health check {identifier} from zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Discard the trial check {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/logs/control/retention/flag'].get update: x-apievangelist-phrasing: intent: Check whether log retention is on effect: read questions: - Is Logpull log retention turned on for my zone? - Are my edge logs being kept so I can pull them later? instructions: - text: Show the log retention flag for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Check if Logpull retention is enabled on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/logs/control/retention/flag'].post update: x-apievangelist-phrasing: intent: Turn Logpull log retention on or off effect: write questions: - How do I start retaining edge logs for Logpull? - Can I stop Logpull from keeping my zone's logs? instructions: - text: Set the log retention flag on zone {zone_identifier} to {flag}. slots: zone_identifier: path.zone_identifier flag: requestBody.flag - text: Enable log retention for Logpull with flag {flag}. slots: flag: requestBody.flag method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/logs/rayids/{ray_identifier}'].get update: x-apievangelist-phrasing: intent: Look up logs by Ray ID effect: read questions: - Can I find the log record for a request using its Ray ID? - Why might one Ray ID return several log records? instructions: - text: Find logs for Ray ID {ray_identifier} on zone {zone_identifier}. slots: ray_identifier: path.ray_identifier zone_identifier: path.zone_identifier - text: Look up Ray {ray_identifier} and return only fields {fields}. slots: ray_identifier: path.ray_identifier fields: query.fields method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/logs/received'].get update: x-apievangelist-phrasing: intent: Pull edge HTTP logs for a time window effect: read questions: - How do I download my zone's HTTP request logs minute by minute? - Can I sample or cap the number of log records returned? - Is the end time inclusive when pulling received logs? instructions: - text: Pull edge logs for zone {zone_identifier} from {start} to {end}. slots: zone_identifier: path.zone_identifier start: query.start end: query.end - text: Fetch {count} received log lines ending at {end} with fields {fields}. slots: count: query.count end: query.end fields: query.fields method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/logs/received/fields'].get update: x-apievangelist-phrasing: intent: List available log fields effect: read questions: - What fields can I request when pulling edge logs? - Where is the description of each Logpull field? instructions: - text: List the Logpull fields available for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Describe every log field I can select on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/rate_limits'].get update: x-apievangelist-phrasing: intent: List a zone's rate limits effect: read questions: - What rate limiting rules are set on my zone? - Can I page through the rate limits on a domain? instructions: - text: List rate limits for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show page {page} of rate limits on zone {zone_identifier}. slots: page: query.page zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/rate_limits'].post update: x-apievangelist-phrasing: intent: Create a rate limit effect: write questions: - How do I throttle clients that hit my login page too often? - Can I add a rate limit to protect an API endpoint? instructions: - text: Create a rate limit on zone {zone_identifier} for my login URL. slots: zone_identifier: path.zone_identifier - text: Add a new request rate limit to zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/rate_limits/{id}'].get update: x-apievangelist-phrasing: intent: Get a rate limit effect: read questions: - What threshold and period does a particular rate limit use? - Can I fetch one rate limit by its ID? instructions: - text: Get rate limit {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Show the threshold of rate limit {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/rate_limits/{id}'].put update: x-apievangelist-phrasing: intent: Update a rate limit effect: write questions: - Can I raise the threshold on an existing rate limit? - How do I disable one rate limit temporarily? instructions: - text: Update rate limit {id} on zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Loosen the threshold of rate limit {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/rate_limits/{id}'].delete update: x-apievangelist-phrasing: intent: Delete a rate limit effect: destructive questions: - Can I remove a rate limit I no longer need? - What happens to throttled clients after a rate limit is deleted? instructions: - text: Delete rate limit {id} from zone {zone_identifier}. slots: id: path.id zone_identifier: path.zone_identifier - text: Remove the throttling rule {id}. slots: id: path.id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/snippets'].get update: x-apievangelist-phrasing: intent: List a zone's snippets effect: read questions: - Which code snippets are deployed on my zone? - Can I see all Snippets for a domain? instructions: - text: List all snippets on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show every snippet deployed to zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/snippets/{snippet_name}'].get update: x-apievangelist-phrasing: intent: Get a snippet's details effect: read questions: - When was a particular snippet created or modified? - Can I look up a snippet by its name? instructions: - text: Get snippet {snippet_name} on zone {zone_identifier}. slots: snippet_name: path.snippet_name zone_identifier: path.zone_identifier - text: Show metadata for snippet {snippet_name}. slots: snippet_name: path.snippet_name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/snippets/{snippet_name}'].put update: x-apievangelist-phrasing: intent: Create or replace a snippet effect: write questions: - How do I upload a new snippet of code to my zone? - Can I overwrite an existing snippet with new files? instructions: - text: Upload snippet {snippet_name} to zone {zone_identifier} with files {files}. slots: snippet_name: path.snippet_name zone_identifier: path.zone_identifier files: requestBody.files - text: Replace the code of snippet {snippet_name} using metadata {metadata}. slots: snippet_name: path.snippet_name metadata: requestBody.metadata method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/snippets/{snippet_name}'].delete update: x-apievangelist-phrasing: intent: Delete a snippet effect: destructive questions: - Can I remove a snippet from my zone? - What happens to snippet rules that reference a deleted snippet? instructions: - text: Delete snippet {snippet_name} from zone {zone_identifier}. slots: snippet_name: path.snippet_name zone_identifier: path.zone_identifier - text: Remove the snippet called {snippet_name}. slots: snippet_name: path.snippet_name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/snippets/{snippet_name}/content'].get update: x-apievangelist-phrasing: intent: Download a snippet's code effect: read questions: - Can I read the source code of a deployed snippet? - Where do I get the actual file content of a snippet? instructions: - text: Download the content of snippet {snippet_name} on zone {zone_identifier}. slots: snippet_name: path.snippet_name zone_identifier: path.zone_identifier - text: Show me the code inside snippet {snippet_name}. slots: snippet_name: path.snippet_name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/snippets/snippet_rules'].get update: x-apievangelist-phrasing: intent: List snippet rules effect: read questions: - Which requests trigger which snippets on my zone? - What rules decide when my snippets run? instructions: - text: List snippet rules for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show when each snippet runs on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/snippets/snippet_rules'].put update: x-apievangelist-phrasing: intent: Replace snippet rules effect: write questions: - Can I set which requests each snippet runs on? - How do I overwrite all the snippet rules for a zone? instructions: - text: Replace the snippet rules on zone {zone_identifier} with {rules}. slots: zone_identifier: path.zone_identifier rules: requestBody.rules - text: 'Save these snippet trigger rules: {rules}.' slots: rules: requestBody.rules method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/ssl/recommendation'].get update: x-apievangelist-phrasing: intent: Get the recommended SSL/TLS mode effect: read questions: - Which SSL/TLS encryption mode does the Recommender suggest for my site? - Is my zone's SSL mode stricter or looser than recommended? instructions: - text: Get the SSL/TLS recommendation for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Tell me what encryption mode the Recommender advises for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms'].get update: x-apievangelist-phrasing: intent: List waiting rooms effect: read questions: - Which waiting rooms are configured on my zone? - Can I see all virtual queues protecting my site? instructions: - text: List waiting rooms on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show every waiting room set up for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms'].post update: x-apievangelist-phrasing: intent: Create a waiting room effect: write questions: - How do I queue visitors when traffic to my site spikes? - Can I cap active users and new users per minute on a host? instructions: - text: Create waiting room {name} on host {host} allowing {total_active_users} active users and {new_users_per_minute} new per minute. slots: name: requestBody.name host: requestBody.host total_active_users: requestBody.total_active_users new_users_per_minute: requestBody.new_users_per_minute - text: Set up a new virtual queue on zone {zone_identifier} for path {path}. slots: zone_identifier: path.zone_identifier path: requestBody.path method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}'].get update: x-apievangelist-phrasing: intent: Get a waiting room's configuration effect: read questions: - What limits and host is a particular waiting room using? - Can I look up a waiting room by ID? instructions: - text: Get waiting room {waiting_room_id} on zone {zone_identifier}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Show the configuration of waiting room {waiting_room_id}. slots: waiting_room_id: path.waiting_room_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}'].put update: x-apievangelist-phrasing: intent: Replace a waiting room's configuration effect: write questions: - Can I fully redefine an existing waiting room? - How do I overwrite every setting of a waiting room at once? instructions: - text: 'Replace room {waiting_room_id} in zone {zone_identifier}: host {host}, name {name}, {total_active_users} active, {new_users_per_minute} new/min.' slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier host: requestBody.host name: requestBody.name total_active_users: requestBody.total_active_users new_users_per_minute: requestBody.new_users_per_minute - text: Overwrite the full config of queue {waiting_room_id}. slots: waiting_room_id: path.waiting_room_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}'].delete update: x-apievangelist-phrasing: intent: Delete a waiting room effect: destructive questions: - Can I remove a waiting room after a launch is over? - What happens to queued visitors when a waiting room is deleted? instructions: - text: Delete waiting room {waiting_room_id} from zone {zone_identifier}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Remove the virtual queue {waiting_room_id}. slots: waiting_room_id: path.waiting_room_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}'].patch update: x-apievangelist-phrasing: intent: Patch selected waiting room settings effect: write questions: - Can I suspend a waiting room without resending its whole config? - Is there a way to change only the queueing method on a waiting room? instructions: - text: Patch waiting room {waiting_room_id} on zone {zone_identifier} to suspended {suspended}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier suspended: requestBody.suspended - text: Switch just the queueing method of room {waiting_room_id} to {queueing_method}. slots: waiting_room_id: path.waiting_room_id queueing_method: requestBody.queueing_method method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events'].get update: x-apievangelist-phrasing: intent: List a waiting room's events effect: read questions: - What scheduled events are set up for my waiting room? - Can I see upcoming sale events on a queue? instructions: - text: List events for waiting room {waiting_room_id} on zone {zone_identifier}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Show scheduled events of queue {waiting_room_id}. slots: waiting_room_id: path.waiting_room_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events'].post update: x-apievangelist-phrasing: intent: Schedule a waiting room event effect: write questions: - How do I schedule a ticket drop that changes my waiting room's behavior? - Can I prequeue users and shuffle them when an event starts? - Can two waiting room events overlap? instructions: - text: Create event {name} on waiting room {waiting_room_id} from {event_start_time} to {event_end_time}. slots: name: requestBody.name waiting_room_id: path.waiting_room_id event_start_time: requestBody.event_start_time event_end_time: requestBody.event_end_time - text: Schedule a launch event on zone {zone_identifier} with prequeue starting at {prequeue_start_time}. slots: zone_identifier: path.zone_identifier prequeue_start_time: requestBody.prequeue_start_time method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}'].get update: x-apievangelist-phrasing: intent: Get a waiting room event effect: read questions: - What start and end time does a specific waiting room event have? - Can I look up one event on a queue by ID? instructions: - text: Get event {event_id} of waiting room {waiting_room_id} on zone {zone_identifier}. slots: event_id: path.event_id waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Show the stored settings of event {event_id}. slots: event_id: path.event_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}'].put update: x-apievangelist-phrasing: intent: Replace a waiting room event effect: write questions: - Can I fully redefine a scheduled waiting room event? - How do I move an event to new start and end times with a full update? instructions: - text: Replace event {event_id} on room {waiting_room_id} in zone {zone_identifier} with name {name}, {event_start_time} to {event_end_time}. slots: event_id: path.event_id waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier name: requestBody.name event_start_time: requestBody.event_start_time event_end_time: requestBody.event_end_time - text: Overwrite the whole configuration of queue event {event_id}. slots: event_id: path.event_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}'].delete update: x-apievangelist-phrasing: intent: Delete a waiting room event effect: destructive questions: - Can I cancel a scheduled waiting room event? - What does the waiting room fall back to when an event is deleted? instructions: - text: Delete event {event_id} from waiting room {waiting_room_id} on zone {zone_identifier}. slots: event_id: path.event_id waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Cancel queue event {event_id}. slots: event_id: path.event_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}'].patch update: x-apievangelist-phrasing: intent: Patch selected waiting room event settings effect: write questions: - Can I suspend a waiting room event without redefining it? - Is there a way to change only an event's session duration? instructions: - text: Patch event {event_id} on room {waiting_room_id} in zone {zone_identifier} to suspended {suspended}. slots: event_id: path.event_id waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier suspended: requestBody.suspended - text: Change only the session duration of event {event_id} to {session_duration}. slots: event_id: path.event_id session_duration: requestBody.session_duration method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details'].get update: x-apievangelist-phrasing: intent: Preview an event's effective settings effect: read questions: - What will my waiting room settings be once an event is active? - Which event values are inherited from the waiting room? instructions: - text: Preview event {event_id} of waiting room {waiting_room_id} on zone {zone_identifier} as if active. slots: event_id: path.event_id waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Show the effective merged config for event {event_id} with inherited values. slots: event_id: path.event_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules'].get update: x-apievangelist-phrasing: intent: List a waiting room's rules effect: read questions: - Which rules let certain visitors bypass my waiting room? - What rules are attached to a queue? instructions: - text: List rules for waiting room {waiting_room_id} on zone {zone_identifier}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Show the bypass rules on queue {waiting_room_id}. slots: waiting_room_id: path.waiting_room_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules'].put update: x-apievangelist-phrasing: intent: Replace all rules on a waiting room effect: write questions: - Can I swap out every rule on a waiting room in one call? - Does replacing waiting room rules need the Advanced subscription? instructions: - text: Replace all rules on waiting room {waiting_room_id} in zone {zone_identifier}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Overwrite the full rule set of queue {waiting_room_id}. slots: waiting_room_id: path.waiting_room_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules'].post update: x-apievangelist-phrasing: intent: Add a rule to a waiting room effect: write questions: - How do I let staff IPs skip the waiting room queue? - Can I add one bypass rule based on an expression? instructions: - text: Add a rule to waiting room {waiting_room_id} on zone {zone_identifier} with expression {expression} and action {action}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier expression: requestBody.expression action: requestBody.action - text: Create a queue rule for {waiting_room_id} matching {expression}. slots: waiting_room_id: path.waiting_room_id expression: requestBody.expression method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}'].delete update: x-apievangelist-phrasing: intent: Delete a waiting room rule effect: destructive questions: - Can I remove one bypass rule from a waiting room? - What happens to visitors a deleted queue rule used to let through? instructions: - text: Delete rule {rule_id} from waiting room {waiting_room_id} on zone {zone_identifier}. slots: rule_id: path.rule_id waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Remove queue rule {rule_id}. slots: rule_id: path.rule_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}'].patch update: x-apievangelist-phrasing: intent: Edit or reorder a waiting room rule effect: write questions: - Can I change the expression on a single waiting room rule? - How do I move a waiting room rule to a different position? instructions: - text: Update rule {rule_id} on waiting room {waiting_room_id} in zone {zone_identifier} to expression {expression} with action {action}. slots: rule_id: path.rule_id waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier expression: requestBody.expression action: requestBody.action - text: Move queue rule {rule_id} to position {position}. slots: rule_id: path.rule_id position: requestBody.position method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status'].get update: x-apievangelist-phrasing: intent: Check whether a waiting room is queueing effect: read questions: - Is my waiting room holding users in a queue right now? - Is an event currently prequeueing users in my waiting room? instructions: - text: Get the live status of waiting room {waiting_room_id} on zone {zone_identifier}. slots: waiting_room_id: path.waiting_room_id zone_identifier: path.zone_identifier - text: Tell me if queue {waiting_room_id} is currently queueing. slots: waiting_room_id: path.waiting_room_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/preview'].post update: x-apievangelist-phrasing: intent: Preview a custom waiting room page effect: write questions: - Can I see how my custom waiting room HTML will look before going live? - How do I get a preview URL for a queue page template? instructions: - text: Create a waiting room page preview on zone {zone_identifier} from {custom_html}. slots: zone_identifier: path.zone_identifier custom_html: requestBody.custom_html - text: Upload this queue page template {custom_html} and give me the preview link. slots: custom_html: requestBody.custom_html method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/settings'].get update: x-apievangelist-phrasing: intent: Get zone-level Waiting Room settings effect: read questions: - Do search engine crawlers bypass my waiting rooms? - What zone-wide Waiting Room settings apply? instructions: - text: Show zone-level Waiting Room settings for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Check if crawlers skip the queues on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/settings'].put update: x-apievangelist-phrasing: intent: Replace zone-level Waiting Room settings effect: write questions: - Can I let search engine crawlers bypass every waiting room on my zone? - How do I overwrite the zone-wide Waiting Room settings? instructions: - text: Replace Waiting Room zone settings on {zone_identifier} with crawler bypass {search_engine_crawler_bypass}. slots: zone_identifier: path.zone_identifier search_engine_crawler_bypass: requestBody.search_engine_crawler_bypass - text: Save the full zone-wide queue settings for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/waiting_rooms/settings'].patch update: x-apievangelist-phrasing: intent: Patch zone-level Waiting Room settings effect: write questions: - Is there a partial update for zone Waiting Room settings? - Can I toggle only the search engine crawler bypass? instructions: - text: Patch zone {zone_identifier} Waiting Room settings to set crawler bypass to {search_engine_crawler_bypass}. slots: zone_identifier: path.zone_identifier search_engine_crawler_bypass: requestBody.search_engine_crawler_bypass - text: Turn off crawler bypass for queues on zone {zone_identifier} and leave the rest. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames'].get update: x-apievangelist-phrasing: intent: List Web3 hostnames effect: read questions: - Which IPFS or Ethereum gateway hostnames are on my zone? - Can I see all Web3 hostnames configured? instructions: - text: List Web3 hostnames for zone {zone_identifier}. slots: zone_identifier: path.zone_identifier - text: Show my Web3 gateway hostnames on zone {zone_identifier}. slots: zone_identifier: path.zone_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames'].post update: x-apievangelist-phrasing: intent: Create a Web3 gateway hostname effect: write questions: - How do I serve IPFS content from my own hostname? - Can I attach a DNSLink when creating a Web3 hostname? instructions: - text: Create Web3 hostname {name} with target {target} on zone {zone_identifier}. slots: name: requestBody.name target: requestBody.target zone_identifier: path.zone_identifier - text: Set up {name} as a gateway with DNSLink {dnslink}. slots: name: requestBody.name dnslink: requestBody.dnslink method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}'].get update: x-apievangelist-phrasing: intent: Get a Web3 hostname effect: read questions: - What target and status does a Web3 hostname have? - Can I look up a gateway hostname by ID? instructions: - text: Get Web3 hostname {identifier} on zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Show details of gateway hostname {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}'].delete update: x-apievangelist-phrasing: intent: Delete a Web3 hostname effect: destructive questions: - Can I remove a Web3 gateway hostname? - What happens to IPFS content served through a deleted gateway hostname? instructions: - text: Delete Web3 hostname {identifier} from zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Remove gateway hostname {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}'].patch update: x-apievangelist-phrasing: intent: Edit a Web3 hostname's description or DNSLink effect: write questions: - Can I change the DNSLink on an existing Web3 hostname? - How do I update a gateway hostname's description? instructions: - text: Set the DNSLink of Web3 hostname {identifier} on zone {zone_identifier} to {dnslink}. slots: identifier: path.identifier zone_identifier: path.zone_identifier dnslink: requestBody.dnslink - text: Change the description of gateway hostname {identifier} to {description}. slots: identifier: path.identifier description: requestBody.description method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list'].get update: x-apievangelist-phrasing: intent: Get an IPFS gateway content list effect: read questions: - Is my IPFS universal path gateway using a block list or allow list? - What content list is applied to a Web3 hostname? instructions: - text: Show the IPFS content list for Web3 hostname {identifier} on zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Check the content list behavior of gateway {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list'].put update: x-apievangelist-phrasing: intent: Replace an IPFS gateway content list effect: write questions: - Can I block specific CIDs on my IPFS gateway? - How do I set the whole content list and its behavior at once? instructions: - text: Set the content list on gateway {identifier} in zone {zone_identifier} to action {action} with entries {entries}. slots: identifier: path.identifier zone_identifier: path.zone_identifier action: requestBody.action entries: requestBody.entries - text: Replace every content list entry on gateway {identifier} with {entries}. slots: identifier: path.identifier entries: requestBody.entries method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries'].get update: x-apievangelist-phrasing: intent: List IPFS gateway content list entries effect: read questions: - Which CIDs or paths are on my gateway's content list? - Can I see each entry in an IPFS content list? instructions: - text: List content list entries for gateway {identifier} on zone {zone_identifier}. slots: identifier: path.identifier zone_identifier: path.zone_identifier - text: Show every blocked item on gateway hostname {identifier}. slots: identifier: path.identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries'].post update: x-apievangelist-phrasing: intent: Add an entry to an IPFS content list effect: write questions: - How do I add one CID to my gateway's content list? - Can I describe why a piece of content was listed? instructions: - text: Add {type} entry {content} to gateway {identifier} on zone {zone_identifier}. slots: type: requestBody.type content: requestBody.content identifier: path.identifier zone_identifier: path.zone_identifier - text: List content {content} on gateway {identifier} with note {description}. slots: content: requestBody.content identifier: path.identifier description: requestBody.description method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}'].get update: x-apievangelist-phrasing: intent: Get an IPFS content list entry effect: read questions: - What content does a specific content list entry refer to? - Can I look up one gateway content list entry by ID? instructions: - text: Get content list entry {content_list_entry_identifier} on gateway {identifier} in zone {zone_identifier}. slots: content_list_entry_identifier: path.content_list_entry_identifier identifier: path.identifier zone_identifier: path.zone_identifier - text: Show entry {content_list_entry_identifier} from the IPFS content list. slots: content_list_entry_identifier: path.content_list_entry_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}'].put update: x-apievangelist-phrasing: intent: Edit an IPFS content list entry effect: write questions: - Can I change the CID on an existing content list entry? - How do I fix a mistaken entry on my gateway content list? instructions: - text: Update entry {content_list_entry_identifier} on gateway {identifier} in zone {zone_identifier} to {type} {content}. slots: content_list_entry_identifier: path.content_list_entry_identifier identifier: path.identifier zone_identifier: path.zone_identifier type: requestBody.type content: requestBody.content - text: Change the note on content entry {content_list_entry_identifier} to {description}. slots: content_list_entry_identifier: path.content_list_entry_identifier description: requestBody.description method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}'].delete update: x-apievangelist-phrasing: intent: Remove an IPFS content list entry effect: destructive questions: - Can I unblock a CID by deleting its content list entry? - What happens when an entry is removed from the gateway content list? instructions: - text: Delete entry {content_list_entry_identifier} from gateway {identifier} on zone {zone_identifier}. slots: content_list_entry_identifier: path.content_list_entry_identifier identifier: path.identifier zone_identifier: path.zone_identifier - text: Remove content list item {content_list_entry_identifier}. slots: content_list_entry_identifier: path.content_list_entry_identifier method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/analytics/aggregate/current'].get update: x-apievangelist-phrasing: intent: Get last-minute Spectrum traffic totals effect: read questions: - How much traffic did my Spectrum apps handle in the last minute? - Can I narrow current Spectrum analytics to one app or data center? instructions: - text: Show current aggregated Spectrum analytics for zone {zone}. slots: zone: path.zone - text: Get last-minute Spectrum usage for app {appID} in colo {colo_name}. slots: appID: query.appID colo_name: query.colo_name method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/analytics/events/bytime'].get update: x-apievangelist-phrasing: intent: Get Spectrum metrics grouped by time effect: read questions: - How has Spectrum traffic changed hour by hour? - Can I bucket Spectrum metrics by a custom time interval? instructions: - text: Show Spectrum {metrics} for zone {zone} by {time_delta} since {since}. slots: metrics: query.metrics zone: path.zone time_delta: query.time_delta since: query.since - text: Chart Spectrum event metrics over time until {until} filtered by {filters}. slots: until: query.until filters: query.filters method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/analytics/events/summary'].get update: x-apievangelist-phrasing: intent: Get a Spectrum analytics summary effect: read questions: - What were my total Spectrum metrics over a period? - Can I get summarized Spectrum metrics split by a dimension? instructions: - text: Summarize Spectrum {metrics} for zone {zone} from {since} to {until}. slots: metrics: query.metrics zone: path.zone since: query.since until: query.until - text: Give me a Spectrum summary broken down by {dimensions}. slots: dimensions: query.dimensions method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/apps'].get update: x-apievangelist-phrasing: intent: List Spectrum applications effect: read questions: - Which Spectrum applications are proxying TCP/UDP on my zone? - Can I sort my Spectrum apps by a field? instructions: - text: List Spectrum applications on zone {zone}. slots: zone: path.zone - text: Show Spectrum apps ordered by {order} {direction}. slots: order: query.order direction: query.direction method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/apps'].post update: x-apievangelist-phrasing: intent: Create a Spectrum app with a named origin effect: write questions: - How do I proxy a TCP or UDP service through my zone with Spectrum? - Can I point a Spectrum app at an origin hostname instead of an IP? instructions: - text: Create a Spectrum app on zone {zone} for {protocol} at {dns} forwarding to {origin_dns} port {origin_port}. slots: zone: path.zone protocol: requestBody.protocol dns: requestBody.dns origin_dns: requestBody.origin_dns origin_port: requestBody.origin_port - text: Set up Spectrum proxying to origin name {origin_dns} with TLS {tls}. slots: origin_dns: requestBody.origin_dns tls: requestBody.tls method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/apps/{app_id}'].get update: x-apievangelist-phrasing: intent: Get a Spectrum app's configuration effect: read questions: - What origin and protocol does a specific Spectrum app use? - Can I look up one Spectrum application by ID? instructions: - text: Get Spectrum application {app_id} on zone {zone}. slots: app_id: path.app_id zone: path.zone - text: Show the configuration of Spectrum app {app_id}. slots: app_id: path.app_id method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/apps/{app_id}'].put update: x-apievangelist-phrasing: intent: Update a Spectrum app with a named origin effect: write questions: - Can I change the origin hostname of an existing Spectrum app? - How do I switch an existing Spectrum app's port or protocol? instructions: - text: Update Spectrum app {app_id} on zone {zone} to {protocol} at {dns}, origin {origin_dns} port {origin_port}. slots: app_id: path.app_id zone: path.zone protocol: requestBody.protocol dns: requestBody.dns origin_dns: requestBody.origin_dns origin_port: requestBody.origin_port - text: Repoint existing Spectrum app {app_id} to origin name {origin_dns}. slots: app_id: path.app_id origin_dns: requestBody.origin_dns method: generated generated: '2026-09-26' - target: $.paths['/zones/{zone}/spectrum/apps/{app_id}'].delete update: x-apievangelist-phrasing: intent: Delete a Spectrum application effect: destructive questions: - Can I stop proxying a service through Spectrum? - What happens to connections when a Spectrum app is deleted? instructions: - text: Delete Spectrum application {app_id} from zone {zone}. slots: app_id: path.app_id zone: path.zone - text: Remove Spectrum app {app_id}. slots: app_id: path.app_id method: generated generated: '2026-09-26'